unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 7521@debbugs.gnu.org, 'Lars Magne Ingebrigtsen' <larsi@gnus.org>
Subject: bug#7521: 24.0.50; doc for `delimit-columns-*'
Date: Sun, 03 Jul 2011 21:08:23 -0400	[thread overview]
Message-ID: <jwv39img8ir.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <06B232927CEE40FC91F8398F1EFDDF97@us.oracle.com> (Drew Adams's message of "Sat, 2 Jul 2011 08:21:40 -0700")

>> > You cannot understand a thing about commands 
>> > `delimit-columns-region' and `delimit-columns-rectangle'
>> > without reading the commentary in Lisp
>> > file delim-col.el.  In sum, there is no help for users - no doc.
>> I suspect that the workings of delim-col.el are too complicated to be
>> explained in a doc string for any of the commands.  If these commands
>> are to be useful to users, I think the proper solution is to document
>> them in the elisp manual.
> You might be right; I really don't know.  My take is that these things
> are explained in the source-code comments, and that this info needs to
> be made available to users via help/doc.  If the details get
> transferred to the manual, OK.

The Elisp manual does not document all Elisp features and packages.
Some packages come with their own manual, and others put their
documentation in the Commentary section.

IOW, I think the current situation where the doc for delim-col.el is in
the Commentary section is "about right".  I know that the commentary
section may seem "hidden away in the source", but the solution is not to
move it elsewhere, but to make it easier to access the Commentary section.


        Stefan





      parent reply	other threads:[~2011-07-04  1:08 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
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 [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=jwv39img8ir.fsf-monnier+emacs@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=7521@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    --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).