aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorStefan Kangas2022-09-10 07:29:48 +0200
committerLars Ingebrigtsen2022-09-10 07:29:48 +0200
commit54c3794899ef2d4d88812fb445b6e2acc85a2720 (patch)
tree328f8905c6b079b14bbf15b1f37abe6f9541a88c /src
parentce4f354defd5f888dfc0bc8feba0396d734ee87f (diff)
downloademacs-54c3794899ef2d4d88812fb445b6e2acc85a2720.tar.gz
emacs-54c3794899ef2d4d88812fb445b6e2acc85a2720.zip
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')
-rw-r--r--src/doc.c15
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)
643DEFUN ("text-quoting-style", Ftext_quoting_style, 643DEFUN ("text-quoting-style", Ftext_quoting_style,
644 Stext_quoting_style, 0, 0, 0, 644 Stext_quoting_style, 0, 0, 0,
645 doc: /* Return the current effective text quoting style. 645 doc: /* Return the current effective text quoting style.
646See variable `text-quoting-style'. */) 646If the variable `text-quoting-style' is `grave', `straight' or
647`curve', just return that value. If it is nil (the default), return
648`grave' if curved quotes cannot be displayed (for instance, on a
649terminal with no support for these characters), otherwise return
650`quote'. Any other value is treated as `grave'.
651
652Note that in contrast to the variable `text-quoting-style', this
653function will never return nil. */)
647 (void) 654 (void)
648{ 655{
649 /* Use grave accent and apostrophe `like this'. */ 656 /* Use grave accent and apostrophe `like this'. */
@@ -694,7 +701,11 @@ The value should be one of these symbols:
694 `grave': quote with grave accent and apostrophe \\=`like this\\='; 701 `grave': quote with grave accent and apostrophe \\=`like this\\=';
695 i.e., do not alter the original quote marks. 702 i.e., do not alter the original quote marks.
696 nil: like `curve' if curved single quotes are displayable, 703 nil: like `curve' if curved single quotes are displayable,
697 and like `grave' otherwise. This is the default. */); 704 and like `grave' otherwise. This is the default.
705
706You should never read the value of this variable directly from a Lisp
707program. Use the function `text-quoting-style' instead, as that will
708compute the correct value for the current terminal in the nil case. */);
698 Vtext_quoting_style = Qnil; 709 Vtext_quoting_style = Qnil;
699 710
700 DEFVAR_BOOL ("internal--text-quoting-flag", text_quoting_flag, 711 DEFVAR_BOOL ("internal--text-quoting-flag", text_quoting_flag,