Subject: bug#56870: [PATCH] Re: bug#56870: company-dabbrev variable documentation

From: YE <[email-masked]>
Date: Thu, 04 Aug 2022 19:06:36 +0300

My take on the 'Init File' docs improvement is attached.

>From d83fd0b706e60e321be695ab7d00ef7d1746258d Mon Sep 17 00:00:00 2001
From: YugaEgo <[email-masked]>
Date: Thu, 4 Aug 2022 18:45:49 +0300
Subject: [PATCH] Expand Init File documentation in Emacs manual

* doc/emacs/custom.texi (Init Syntax):
Add 'Other Lisp symbols' item.  Expand 'True' and 'False' items docs.
Add indexes.
(Init Examples): Mention doc strings convention for symbols.  (Bug#56870)
---
 doc/emacs/custom.texi | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi
index 6ed43bcb79..e9b65b66ce 100644
--- a/doc/emacs/custom.texi
+++ b/doc/emacs/custom.texi
@@ -2442,13 +2442,31 @@ Init Syntax
 keys which send non-@acronym{ASCII} characters.
 
 @item True:
-@code{t} stands for ``true''.
+@cindex @code{t}
+@cindex true
+@cindex boolean
+The special symbol @code{t} stands for ``true''.  @xref{Constant
+Variables,,, elisp, The Emacs Lisp Reference Manual}.
 
 @item False:
-@code{nil} stands for ``false''.
+@cindex @code{nil}
+@cindex false
+@cindex boolean
+The special symbol @code{nil} stands for ``false''.  @xref{Constant
+Variables,,, elisp, The Emacs Lisp Reference Manual}).
+
+@item Other Lisp symbols:
+@cindex Lisp symbol syntax
+@cindex symbol syntax
+Write a single-quote (@code{'}) followed by the symbol name
+(@pxref{Symbols,,, elisp, The Emacs Lisp Reference Manual}).  Note
+that documentation strings refer to symbols by their names only,
+without the single-quote (@pxref{Documentation Tips,,, elisp, The
+Emacs Lisp Reference Manual}).
 
 @item Other Lisp objects:
 @cindex Lisp object syntax
+@cindex object syntax
 Write a single-quote (@code{'}) followed by the Lisp object you want.
 @end table
 
@@ -2515,7 +2533,9 @@ Init Examples
 Note that @code{text-mode} is used because it is the command for
 entering Text mode.  The single-quote before it makes the symbol a
 constant; otherwise, @code{text-mode} would be treated as a variable
-name.
+name.  By convention, documentation strings refer to symbol arguments
+by their names, without the single-quote (@pxref{Documentation Tips,,,
+elisp, The Emacs Lisp Reference Manual}).
 
 @need 1500
 @item
-- 
2.34.1