all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Glenn Morris'" <rgm@gnu.org>, <10868@debbugs.gnu.org>
Subject: bug#10868: 24.0.93; `comment-style' needs to be explained
Date: Wed, 22 Feb 2012 11:01:08 -0800	[thread overview]
Message-ID: <3251750A293C4D74AAB64FD8672192CE@us.oracle.com> (raw)
In-Reply-To: <5b4nuizqj9.fsf@fencepost.gnu.org>

 
> > Read the bug #3370 thread, if you want to understand the problem.
> 
> Unfortunately, I did. It is long-winded and goes nowhere.
> I encourage everyone else not to bother.

Is it really so hard to understand?

 "the doc string for `comment-style' (which is pretty much
  useless) refers to `comment-styles', which is not
  recognized (and therefore has no link)."

emacs -Q

C-h v comment-style

 Style to be used for `comment-region'.
 See `comment-styles' for a list of available styles.

C-h v comment-styles

Bzzzzt -not recognized - no such variable, no such "list of available styles"
... until you load newcomment.el.

There is a user option (`comment-style'), which you can customize.  But its doc
tells you nothing useful.  It just refers you to an internal variable
(`comment-styles'), which has no doc until you load its library.

The doc for `comment-styles' _is_ helpful ... once it becomes available.

Here is a case where we actually autoload a user option, `comment-style', so its
(useless) doc is available prior to loading the library.

But that doc string just refers you to a variable (constant, actually) whose doc
(the advertised "list of available styles") is not available until you load the
library.

Bravo.  Thanks for helping users out.

> > There is no _explanation_ of `comment-style'.
> 
> Right, well, good luck with your future bug reporting.

So constructive.






  reply	other threads:[~2012-02-22 19:01 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-02-22 17:17 bug#10868: 24.0.93; `comment-style' needs to be explained Drew Adams
2012-02-22 17:38 ` Glenn Morris
2012-02-22 18:06   ` Drew Adams
2012-02-22 18:11     ` Glenn Morris
2012-02-22 19:01       ` Drew Adams [this message]
2012-02-23  9:22         ` Lawrence Mitchell
2012-02-23 14:31           ` Stefan Monnier
2012-02-23 15:35             ` Drew Adams
2012-02-23 16:04               ` Stefan Monnier
2012-02-23 16:13                 ` Drew Adams
2012-02-25  3:08             ` Chong Yidong
2012-02-23 17:16           ` Glenn Morris
2012-02-23 17:22             ` Glenn Morris
2012-02-23 17:24             ` Lawrence Mitchell
2012-02-23 17:34             ` Drew Adams
2012-02-23 21:48             ` Finding a variable before it's loaded Stefan Monnier
2012-02-23 22:29               ` Lennart Borgman

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=3251750A293C4D74AAB64FD8672192CE@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=10868@debbugs.gnu.org \
    --cc=rgm@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.