[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: "What's This?" in Describe submenu

From: Stefan Monnier
Subject: Re: "What's This?" in Describe submenu
Date: Tue, 23 Aug 2005 15:56:11 -0400
User-agent: Gnus/5.11 (Gnus v5.11) Emacs/22.0.50 (gnu/linux)

> Now, I agree that what we say sounds not very clear (to say the least)
> to a newbie, but I think we do mean to target newbies as well, and
> that therefore we should work on making the doc string more
> newbie-friendly.  But I'm repeating myself...

I've several times hesitated when writing a docstring: should it document
the function or the command.
The more typical problem is whether to refer to ARG, BEG, END or to
\\[universal-argument], and the region.
Maybe we should make i possible to provide two separate docstrings, one for
the function and one for the command.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]