From: Stefan Monnier <monnier@IRO.UMontreal.CA>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 7509@debbugs.gnu.org
Subject: bug#7509: 24.0.50; doc for `comment-style' and `comment-styles'
Date: Sun, 28 Nov 2010 16:01:11 -0500 [thread overview]
Message-ID: <jwv62vhuq44.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <9166F5772B0D414D84ECE3808ECD3964@us.oracle.com> (Drew Adams's message of "Sun, 28 Nov 2010 11:42:46 -0800")
> 1. User option `comment-style' should be documented in the Emacs manual.
Indeed. It probably doesn't need to be in the Elisp manual, but the
User manual should mention it.
> 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).
From a modularity point of view, this is somewhat problematic.
So I have philosophical problems with this, although I agree that the
current docstring doesn't work well in Custom.
Maybe a solution is to extend comment-styles so it includes a short
docstring for each entry that can then be used for the label on each
value in the "Value menu" of comment-style.
> 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.
I don't understand: the docstring of comment-styles (like all other
variable docstrings) doesn't describe its current value, but rather what
are its possible value(s) and what they mean. It seems to be just as
up-to-date as when I originally wrote it (that part of the code hasn't
changed since, AFAIK).
Stefan
next prev parent reply other threads:[~2010-11-28 21:01 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-11-28 19:42 bug#7509: 24.0.50; doc for `comment-style' and `comment-styles' Drew Adams
2010-11-28 21:01 ` Stefan Monnier [this message]
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=jwv62vhuq44.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--cc=7509@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
/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.