From: "Drew Adams" <drew.adams@oracle.com>
To: 7509@debbugs.gnu.org
Subject: bug#7509: 24.0.50; doc for `comment-style' and `comment-styles'
Date: Sun, 28 Nov 2010 11:42:46 -0800 [thread overview]
Message-ID: <9166F5772B0D414D84ECE3808ECD3964@us.oracle.com> (raw)
1. User option `comment-style' should be documented in the Emacs manual.
It is in neither that manual nor the Elisp manual.
Don't bother to answer that not all options are described in the manual
- your stock reply. This is a bug report about a _particular_ option's
(lack of) doc.
2. The doc string of `comment-style' should explain what each of the
possible values is/does. It should not refer you to the doc string for
`comment-styles' (a defconst).
The `comment-style' doc string should explain the values in a way that
makes sense for `M-x customize-option custom-style', that is, not just
with reference to the Lisp values but in terms of the `Value Menu'
labels.
Users of Customize should not just be sent to a defconst doc string that
requires them to somehow map the `Value Menu' labels against the Lisp
values. It is perfectly OK to _also_ say "see also `comment-style'.
And the latter's doc string _should_ of course describe the Lisp values.
3. The doc string of `comment-styles' is anyway out of date. Not all of
the values are described. This means that users trying to customize
`comment-style' are lost.
In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
of 2010-11-22 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4) --no-opt --cflags
-Ic:/imagesupport/include'
next reply other threads:[~2010-11-28 19:42 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-11-28 19:42 Drew Adams [this message]
2010-11-28 21:01 ` bug#7509: 24.0.50; doc for `comment-style' and `comment-styles' Stefan Monnier
2010-11-28 22:34 ` Drew Adams
2010-11-28 22:49 ` Drew Adams
2010-11-30 18:15 ` Stefan Monnier
2010-11-30 19:13 ` Drew Adams
2010-11-30 22:06 ` Stefan Monnier
2010-11-30 22:36 ` Drew Adams
2010-12-01 2:57 ` Stefan Monnier
2010-12-01 4:10 ` Drew Adams
2010-12-03 23:16 ` Stefan Monnier
2010-12-03 23:34 ` Drew Adams
2010-11-29 1:38 ` Stefan Monnier
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=9166F5772B0D414D84ECE3808ECD3964@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=7509@debbugs.gnu.org \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.