]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve formatting in text-quoting-style docstring
authorStefan Kangas <stefan@marxist.se>
Thu, 6 May 2021 14:31:20 +0000 (16:31 +0200)
committerStefan Kangas <stefan@marxist.se>
Thu, 6 May 2021 14:31:20 +0000 (16:31 +0200)
* src/doc.c (syms_of_doc) <text-quoting-style>: Doc fix; improve
formatting for readability.

src/doc.c

index e179a126184071704573246a93da0e91cc2ffc0d..63e0cbbb432470c6081a61fb72d7093aed388982 100644 (file)
--- a/src/doc.c
+++ b/src/doc.c
@@ -719,17 +719,19 @@ syms_of_doc (void)
 
   DEFVAR_LISP ("text-quoting-style", Vtext_quoting_style,
                doc: /* Style to use for single quotes in help and messages.
-Its value should be a symbol.  It works by substituting certain single
-quotes for grave accent and apostrophe.  This is done in help output
-\(but not for display of Info manuals) and in functions like `message'
-and `format-message'.  It is not done in `format'.
-
-`curve' means quote with curved single quotes ‘like this’.
-`straight' means quote with straight apostrophes \\='like this\\='.
-`grave' means quote with grave accent and apostrophe \\=`like this\\=';
-i.e., do not alter quote marks.  The default value nil acts like
-`curve' if curved single quotes are displayable, and like `grave'
-otherwise.  */);
+
+This works by substituting certain single quotes for grave accent and
+apostrophe.  This is done in help output (but not for display of Info
+manuals) and in functions like `message' and `format-message'.  It is
+not done in `format'.
+
+Its value should be one of these symbols:
+  `curve':    quote with curved single quotes ‘like this’.
+  `straight': quote with straight apostrophes \\='like this\\='.
+  `grave':    quote with grave accent and apostrophe \\=`like this\\=';
+             i.e., do not alter quote marks.
+  nil:        like `curve' if curved single quotes are displayable,
+             and like `grave' otherwise.  */);
   Vtext_quoting_style = Qnil;
 
   DEFVAR_BOOL ("internal--text-quoting-flag", text_quoting_flag,