all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Lars Magne Ingebrigtsen'" <larsi@gnus.org>
Cc: 957@debbugs.gnu.org
Subject: bug#957: 23.0.60; No doc string for Dired functions
Date: Wed, 6 Jul 2011 12:16:37 -0700	[thread overview]
Message-ID: <A19DDB8C2DE1421597ED6CD83020BDC4@us.oracle.com> (raw)
In-Reply-To: <m3k4bvxo0u.fsf@quimbies.gnus.org>

> > There is still no doc string for many useful Dired functions, from
> > things like `dired-repeat-overlines' to all of the tree Dired
> > non-interactive functions. At a minimum, the arguments should be
> > described in a doc string. Even some commands, like 
> > `dired-kill-line', still have no doc.
> 
> I've added a doc to `dired-kill-line'

Thank you.

> but I don't know what `dired-repeat-overlines' is...

All the more reason for it to get a doc string!

You don't know what it is, but _it_ should know what it is and be able to tell
us.  Someone (TM) will need to figure that out and give it a little help in the
self-explanation department.

> And the noninteractive functions don't need doc strings,
> really, do they?

Sure they do, in general.  Since when do we document only commands?

In the Dark Ages, doc strings were relatively more expensive (disk, memory,
etc.), and some minor functions were handled with only a comment.  Nowadays
there is rarely a good reason not to provide a doc string.

Emacs is the self-documenting editor.  If you must access the source code just
to get a description of a function from comments, or worse, to parse uncommented
code to figure out what a function does, then Emacs is not doing its
self-documenting job well.






  reply	other threads:[~2011-07-06 19:16 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-09-10 16:16 bug#957: 23.0.60; No doc string for Dired functions Drew Adams
2011-07-06 18:27 ` Lars Magne Ingebrigtsen
2011-07-06 19:16   ` Drew Adams [this message]
2011-07-07 16:30     ` Lars Magne Ingebrigtsen
2011-07-07 16:43       ` Drew Adams
2011-07-07 16:48         ` Lars Magne Ingebrigtsen
     [not found] <mailman.18915.1221064059.18990.bug-gnu-emacs@gnu.org>
2008-09-11 20:55 ` Roland Winkler

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=A19DDB8C2DE1421597ED6CD83020BDC4@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=957@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 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.