From: YE via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: Matt Armstrong <matt@rfc20.org>, uzibalqa <uzibalqa@proton.me>,
56870@debbugs.gnu.org
Subject: bug#56870: company-dabbrev variable documentation
Date: Wed, 03 Aug 2022 13:07:02 +0300 [thread overview]
Message-ID: <m2edxxiqt5.fsf@ego.team> (raw)
In-Reply-To: <87y1w7ymiu.fsf@gnus.org> (Lars Ingebrigtsen's message of "Tue, 02 Aug 2022 12:20:41 +0200")
> So I don't think there's anything to fix in Emacs here -- we sometimes
> say "the symbol `all'" if there's an unusual amount of possible
> confusion present -- and I'm therefore closing this bug report.
I'd still suggest considering documentation improvement in this regard.
Probably because I had the same confusion when started with Emacs, even
after having read the whole manual.
[Well, the info node `(elisp) Documentation Tips)' clarifies how to
document symbols :
> When a documentation string refers to a Lisp symbol, write it as it
> would be printed (which usually means in lower case), surrounding
> it with curved single quotes (‘..’)
But Emacs beginner users don't seem to be the target auditory of this
page. And it still won't -- naturally -- explain how to _use_ such
symbols.]
One such possible place to adjust is the info node `(emacs) Examining'.
Maybe replace 'fill-column' example with the one that accepts a
documented symbol (f.i. 'default-justification', 'diff-refine',
'tab-always-complete') and use the symbol in the code below?
Another: info node `(emacs) Init Syntax' could probably state more
explicitly how to deal with the symbols.
Or mention symbols documentation/usage at the end of the info node
`(emacs) Variables', after the line "check the variable’s documentation
string to see what kind of value it expects".
WDYT?
next prev parent reply other threads:[~2022-08-03 10:07 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 [this message]
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 ` bug#56870: [PATCH] " YE via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-08-04 16:41 ` 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=m2edxxiqt5.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).