unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Luc Teirlinck <teirllm@dms.auburn.edu>
Cc: rudalics@gmx.at, eliz@gnu.org, emacs-devel@gnu.org
Subject: Re: "What's This?" in Describe submenu
Date: Tue, 23 Aug 2005 18:05:14 -0500 (CDT)	[thread overview]
Message-ID: <200508232305.j7NN5EQ18152@raven.dms.auburn.edu> (raw)
In-Reply-To: <jwv64twa0py.fsf-monnier+emacs@gnu.org> (message from Stefan Monnier on Tue, 23 Aug 2005 15:56:11 -0400)

Stefan Monnier wrote:

   I've several times hesitated when writing a docstring: should it document
   the function or the command.

I normally include paragraphs saying "When used interactively..." to
document the command and "When used from Lisp..." to document the
function.  But the fact remains that for complete newbies, the Emacs
manual usually provides better documentation than docstrings.

Sincerely,

Luc.

  reply	other threads:[~2005-08-23 23:05 UTC|newest]

Thread overview: 66+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-08-21  8:21 "What's This?" in Describe submenu martin rudalics
2005-08-21 17:26 ` Luc Teirlinck
2005-08-21 17:59   ` Luc Teirlinck
2005-08-21 21:22     ` Eli Zaretskii
2005-08-21 21:38       ` Luc Teirlinck
2005-08-22  3:35         ` Eli Zaretskii
2005-08-22  3:55           ` Luc Teirlinck
2005-08-22  4:30           ` Luc Teirlinck
2005-08-22 20:04             ` Eli Zaretskii
2005-08-22 23:39               ` Luc Teirlinck
2005-08-21 22:10       ` Luc Teirlinck
2005-08-21 17:45 ` Luc Teirlinck
2005-08-21 18:35 ` Luc Teirlinck
2005-08-22  0:06 ` Richard M. Stallman
2005-08-22  0:50   ` Luc Teirlinck
2005-08-22  8:52     ` Lennart Borgman
2005-08-22  9:09     ` Lennart Borgman
2005-08-22 19:35     ` Richard M. Stallman
2005-08-22 22:16       ` Luc Teirlinck
2005-08-22 22:59       ` Luc Teirlinck
2005-08-22  1:59   ` David Robinow
2005-08-22  3:38     ` Eli Zaretskii
2005-08-22  7:17     ` Jason Rumney
2005-08-22 10:43       ` David Kastrup
2005-08-22 19:35     ` Richard M. Stallman
2005-08-22 23:15       ` Luc Teirlinck
2005-08-22  7:58   ` Kim F. Storm
2005-08-22 16:37     ` Drew Adams
2005-08-23  1:29       ` Richard M. Stallman
2005-08-22 19:53     ` Eli Zaretskii
2005-08-22 20:15       ` Stefan Monnier
2005-08-23  3:42         ` Eli Zaretskii
2005-08-23  0:08       ` Luc Teirlinck
2005-08-23  3:47         ` Eli Zaretskii
2005-08-23  4:23           ` Luc Teirlinck
2005-08-23 14:40             ` Luc Teirlinck
2005-08-23 19:22             ` Eli Zaretskii
2005-08-23 20:55               ` Luc Teirlinck
2005-08-23  4:29           ` Luc Teirlinck
2005-08-23  7:15             ` Jason Rumney
2005-08-23 14:37               ` Luc Teirlinck
2005-08-23  4:40           ` Luc Teirlinck
2005-08-23 19:36             ` Eli Zaretskii
2005-08-23 20:56               ` Jason Rumney
2005-08-24  3:38                 ` Eli Zaretskii
2005-08-24 12:46                   ` Luc Teirlinck
2005-08-24 14:10                     ` David Robinow
2005-08-24 18:51                       ` Luc Teirlinck
2005-08-25 10:42                       ` Richard M. Stallman
2005-08-23  4:56           ` Luc Teirlinck
2005-08-23 19:34             ` Eli Zaretskii
2005-08-23 19:56               ` Stefan Monnier
2005-08-23 23:05                 ` Luc Teirlinck [this message]
2005-08-24 10:33                 ` Richard M. Stallman
2005-08-23 22:02               ` Luc Teirlinck
2005-08-24  3:46                 ` Eli Zaretskii
2005-08-25  8:54                   ` Kim F. Storm
2005-08-25 18:05                     ` Eli Zaretskii
2005-08-23  1:29     ` Richard M. Stallman
2005-08-22 16:23   ` Drew Adams
  -- strict thread matches above, loose matches on Subject: below --
2005-08-23 14:08 Drew Adams
2005-08-23 14:31 ` David Kastrup
2005-08-23 19:40 ` Eli Zaretskii
2005-08-23 20:53   ` Jason Rumney
2005-08-24  3:39     ` Eli Zaretskii
2005-08-24  7:15       ` Jason Rumney

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=200508232305.j7NN5EQ18152@raven.dms.auburn.edu \
    --to=teirllm@dms.auburn.edu \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=rudalics@gmx.at \
    /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).