unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Stefan Monnier'" <monnier@iro.umontreal.ca>
Cc: 'era eriksson' <era+gmane@iki.fi>, bug-gnu-emacs@gnu.org
Subject: RE: Documentation for ido-mode is not very enlightening
Date: Wed, 27 Feb 2008 13:34:37 -0800	[thread overview]
Message-ID: <004a01c87988$8dd09770$0600a8c0@us.oracle.com> (raw)
In-Reply-To: <jwvablmce3r.fsf-monnier+emacs@gnu.org>

> > Maybe the byte-compiler should preserve the Commentary, 
> > since some runtime code depends on it? ;-) 
> 
> > Half-kidding. There's also a large variation in the amount 
> > and quality of Commentary doc. This feature is of only limited value.
>
> If by "this feature" you mean finder-commentary, I somewhat agree.
> But the feature to jump to the source code OTOH is very important to
> encourage people to contribute.

I agree.

I meant only that it is not an ideal substitute for doc in another form, and
that YMMV in terms of the helpfulness of a particular Commentary.

I also think that it's useful to put :link '(emacs-commentary-link LIBRARY)
in  defcustom's, defgroup's, and defface's. That's another way to give users
a way to get to the Commentary (it uses finder-commentary). And a developer
who takes the trouble of adding such a :link is likely to spend more time
trying to make the Commentary useful.

This is is why I was only half-kidding. Ideally, a runtime command such as
finder-commentary would have everything it needs, even from a byte-compiled
file. But I agree that a simple error message is probably TRT thing now, if
the source file is missing.

Another area for possible improvement might be some rudimentary Commentary
navigation and other commands (keys) in Finder mode. `finder-select' could
also be improved a bit perhaps. And we might even want to come up with some
guidelines for writing Commentary that would facilitate using Finder mode.

Not a high priority, but maybe something to think about in our spare time.
;-) It is definitely true that useful info is often in the source-code
Commentary. Ido mode is apparently one example.





      reply	other threads:[~2008-02-27 21:34 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-02-24 19:04 Documentation for ido-mode is not very enlightening era
2008-02-25 14:10 ` martin rudalics
2008-02-25 19:01   ` era eriksson
2008-02-25 21:49     ` martin rudalics
2008-02-25 22:04     ` Jason Rumney
2008-02-26 19:23       ` era eriksson
2008-02-26 21:14         ` Stefan Monnier
2008-02-27  7:48           ` era eriksson
2008-02-27 16:17             ` Stefan Monnier
2008-02-27 16:30               ` Drew Adams
2008-02-27 21:01                 ` Stefan Monnier
2008-02-27 21:34                   ` Drew Adams [this message]

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='004a01c87988$8dd09770$0600a8c0@us.oracle.com' \
    --to=drew.adams@oracle.com \
    --cc=bug-gnu-emacs@gnu.org \
    --cc=era+gmane@iki.fi \
    --cc=monnier@iro.umontreal.ca \
    /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).