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: 8682@debbugs.gnu.org
Subject: bug#8682: 24.0.50; doc strings of `isearch-mode', `isearch-forward', etc.
Date: Fri, 15 Jul 2011 08:06:06 -0700	[thread overview]
Message-ID: <5DED13DA31E94AF9BF6B244A80E299D4@us.oracle.com> (raw)
In-Reply-To: <m3y5zz8xxl.fsf@quimbies.gnus.org>

> It's an internal function.

"Internal" functions too deserve doc strings, in general.

And nothing in Emacs is truly "internal".  Emacs purposefully documents itself,
at all levels.  That documentation is available to all users interactively.

Skip creating reasonable doc strings and you stab Emacs, the "self-documenting
editor", in the back.

It was only in the Dark Ages, when doc strings were expensive because hardware
was expensive, that we used comments instead of doc strings for many "internal"
functions.

We should not be lazy and cop out wrt "internal" functions.  There is no strict
separation in Emacs (or GNU generally) between users and developers, between
"internal" code and external use of that code.

> The only thing that's useful in that doc string is the thing that's
> already there, and which you want removed:
> 
> > And you can remove this sentence from the doc string - a 
> > function's doc should, in general, not mention callers:
> > "It is called by the function `isearch-forward' and other related
> > functions."

No, that is not "useful".  More importantly, it is generally a bad idea for a
callee to call out who calls it.  There are exceptional cases, but this is not
one.






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

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-05-17 14:25 bug#8682: 24.0.50; doc strings of `isearch-mode', `isearch-forward', etc Drew Adams
2011-05-17 14:39 ` Stefan Monnier
2011-05-17 14:46   ` Drew Adams
2011-05-17 17:32     ` Stefan Monnier
2011-05-17 19:12       ` Drew Adams
2011-07-15 13:40 ` Lars Magne Ingebrigtsen
2011-07-15 15:06   ` Drew Adams [this message]
2011-07-15 16:56     ` Juanma Barranquero
2011-07-15 18:30       ` Drew Adams
2011-07-15 14:43 ` Drew Adams
2011-07-15 15:02   ` Lars Magne Ingebrigtsen
2011-07-15 15:02   ` Lars Magne Ingebrigtsen
2011-07-18 14:06   ` Stefan Monnier
2011-07-18 14:13     ` Drew Adams
2013-05-20 22:50       ` Juri Linkov

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=5DED13DA31E94AF9BF6B244A80E299D4@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=8682@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).