diff options
| author | Stefan Kangas <stefan@marxist.se> | 2022-09-10 07:29:48 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2022-09-10 07:29:48 +0200 |
| commit | 54c3794899ef2d4d88812fb445b6e2acc85a2720 (patch) | |
| tree | 328f8905c6b079b14bbf15b1f37abe6f9541a88c /src/doc.c | |
| parent | ce4f354defd5f888dfc0bc8feba0396d734ee87f (diff) | |
| download | emacs-54c3794899ef2d4d88812fb445b6e2acc85a2720.tar.gz | |
Doc fixes for 'text-quoting-style'
* doc/lispref/help.texi (Keys in Documentation): Remove duplicate
entry for 'text-quoting-style'. Document the function with the same
name instead.
* src/doc.c (Ftext_quoting_style): Doc fix: clarify the return values.
(syms_of_doc) <Vtext_quoting_style>: Doc fix: clarify that you should
not read the value of this variable directly; use Ftext_quoting_style
instead (bug#51040).
Diffstat (limited to 'src/doc.c')
| -rw-r--r-- | src/doc.c | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/src/doc.c b/src/doc.c index 34b80d03aa9..d98d121ebd5 100644 --- a/src/doc.c +++ b/src/doc.c @@ -643,7 +643,14 @@ default_to_grave_quoting_style (void) DEFUN ("text-quoting-style", Ftext_quoting_style, Stext_quoting_style, 0, 0, 0, doc: /* Return the current effective text quoting style. -See variable `text-quoting-style'. */) +If the variable `text-quoting-style' is `grave', `straight' or +`curve', just return that value. If it is nil (the default), return +`grave' if curved quotes cannot be displayed (for instance, on a +terminal with no support for these characters), otherwise return +`quote'. Any other value is treated as `grave'. + +Note that in contrast to the variable `text-quoting-style', this +function will never return nil. */) (void) { /* Use grave accent and apostrophe `like this'. */ @@ -694,7 +701,11 @@ The value should be one of these symbols: `grave': quote with grave accent and apostrophe \\=`like this\\='; i.e., do not alter the original quote marks. nil: like `curve' if curved single quotes are displayable, - and like `grave' otherwise. This is the default. */); + and like `grave' otherwise. This is the default. + +You should never read the value of this variable directly from a Lisp +program. Use the function `text-quoting-style' instead, as that will +compute the correct value for the current terminal in the nil case. */); Vtext_quoting_style = Qnil; DEFVAR_BOOL ("internal--text-quoting-flag", text_quoting_flag, |