From: YE via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Matt Armstrong <matt@rfc20.org>
Cc: yet@ego.team, uzibalqa@proton.me, larsi@gnus.org, 56870@debbugs.gnu.org
Subject: bug#56870: [PATCH] Re: bug#56870: company-dabbrev variable documentation
Date: Thu, 04 Aug 2022 19:06:36 +0300 [thread overview]
Message-ID: <m235ecgfhv.fsf@ego.team> (raw)
In-Reply-To: <87sfmd2mqk.fsf@rfc20.org> (message from Matt Armstrong on Wed, 03 Aug 2022 11:41:39 -0700)
[-- Attachment #1: Type: text/plain, Size: 58 bytes --]
My take on the 'Init File' docs improvement is attached.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Expand Init File docs --]
[-- Type: text/x-patch, Size: 2192 bytes --]
From d83fd0b706e60e321be695ab7d00ef7d1746258d Mon Sep 17 00:00:00 2001
From: YugaEgo <yet@ego.team>
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
next prev parent reply other threads:[~2022-08-04 16:06 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-01 3:54 bug#56870: company-dabbrev variable documentation uzibalqa via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-01 21:24 ` Matt Armstrong
2022-08-01 21:32 ` uzibalqa via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-01 21:49 ` Matt Armstrong
2022-08-01 21:55 ` uzibalqa via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-01 21:49 ` uzibalqa via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-02 10:20 ` Lars Ingebrigtsen
2022-08-02 10:34 ` uzibalqa via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-03 10:07 ` YE via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-03 18:41 ` Matt Armstrong
2022-08-03 18:50 ` carlmarcos--- via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-04 17:09 ` Matt Armstrong
[not found] ` <878ro4rl4l.fsf@rfc20.org-N8dpYwc----2>
2022-08-04 21:59 ` carlmarcos--- via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-04 16:06 ` YE via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2022-08-04 16:41 ` bug#56870: [PATCH] " Eli Zaretskii
2022-08-04 17:48 ` Matt Armstrong
2022-08-04 18:25 ` Eli Zaretskii
2022-08-05 9:10 ` YE via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-05 11:09 ` Eli Zaretskii
2022-08-05 11:36 ` carlmarcos--- via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-06 12:42 ` YE via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-06 13:19 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=m235ecgfhv.fsf@ego.team \
--to=bug-gnu-emacs@gnu.org \
--cc=56870@debbugs.gnu.org \
--cc=larsi@gnus.org \
--cc=matt@rfc20.org \
--cc=uzibalqa@proton.me \
--cc=yet@ego.team \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).