unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Lars Magne Ingebrigtsen'" <larsi@gnus.org>
Cc: 7521@debbugs.gnu.org
Subject: bug#7521: 24.0.50; doc for `delimit-columns-*'
Date: Sat, 2 Jul 2011 08:59:20 -0700	[thread overview]
Message-ID: <91E7FDE1A1EE45B6A5E0214F98214207@us.oracle.com> (raw)
In-Reply-To: <m3fwmon1bt.fsf@quimbies.gnus.org>

> > But even then the doc strings of the various functions 
> > (these are user _commands_, after all) need to give some
> > explanation.  If we cannot explain these commands at all
> > then maybe that's a sign that the
> > commands themselves are overly complex.
> 
> There are oodles of commands tied to various modes/packages 
> that presume that you're aware of what the general gist of
> the package is.

There is certainly no need and no use in describing the general gist of a
package in the doc for each of the packages commands.  That's not the point at
all.

> It wouldn't be very productive to explain the concept of a
> Message buffer in each message-mode command, for instance.

Of course, but that's not the request.  I don't use `message-mode', but I would
guess (hope) that the doc for each of its _commands_ describes that command.

If there were a `message-mode' command `msg-delete' (fictitious example) that
deleted the current message then I would hope its doc string would say that's
what it does.






  reply	other threads:[~2011-07-02 15:59 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-11-30 19:34 bug#7521: 24.0.50; doc for `delimit-columns-*' Drew Adams
2011-07-02 13:44 ` Lars Magne Ingebrigtsen
2011-07-02 15:21   ` Drew Adams
2011-07-02 15:34     ` Lars Magne Ingebrigtsen
2011-07-02 15:59       ` Drew Adams [this message]
2011-07-02 16:10         ` Lars Magne Ingebrigtsen
2011-07-02 16:28           ` Drew Adams
2011-07-02 16:30             ` Lars Magne Ingebrigtsen
2011-07-02 16:32               ` Drew Adams
2011-07-04  1:08     ` 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

  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=91E7FDE1A1EE45B6A5E0214F98214207@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=7521@debbugs.gnu.org \
    --cc=larsi@gnus.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 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).