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 /doc/lispref/help.texi | |
| 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 'doc/lispref/help.texi')
| -rw-r--r-- | doc/lispref/help.texi | 26 |
1 files changed, 7 insertions, 19 deletions
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 463039c5a0e..ac284f745f4 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -374,25 +374,6 @@ as link in the @file{*Help*} buffer. @strong{Please note:} Each @samp{\} must be doubled when written in a string in Emacs Lisp. -@defopt text-quoting-style -@cindex curved quotes -@cindex curly quotes -The value of this variable is a symbol that specifies the style Emacs -should use for single quotes in the wording of help and messages. If -the variable's value is @code{curve}, the style is @t{‘like this’} -with curved single quotes. If the value is @code{straight}, the style -is @t{'like this'} with straight apostrophes. If the value is -@code{grave}, quotes are not translated and the style is @t{`like -this'} with grave accent and apostrophe, the standard style before -Emacs version 25. The default value @code{nil} acts like @code{curve} -if curved single quotes seem to be displayable, and like @code{grave} -otherwise. - -This option is useful on platforms that have problems with curved -quotes. You can customize it freely according to your personal -preference. -@end defopt - @defun substitute-command-keys string &optional no-face include-menus @vindex help-key-binding@r{ (face)} This function scans @var{string} for the above special sequences and @@ -505,6 +486,13 @@ quotes. You can customize it freely according to your personal preference. @end defopt +@defun text-quoting-style +You should not read the value of the variable +@code{text-quoting-style} directly. Instead, use this function with +the same name to dynamically compute the correct quoting style on the +current terminal in the @code{nil} case described above. +@end defun + @node Describing Characters @section Describing Characters for Help Messages @cindex describe characters and events |