[climacs-devel] Re: Climacs - self documenting editor?

[John Q Splittist]

John Q Splittist <splittist <at> yahoo.com> writes:

> True. I present the attached as a start on the other end of the problem

These docstrings have now been added.

The general format I adopted was to begin each docstring with a short line, 
then (in most cases) have a more general set of information in the following 
line. I've also included some FIXME stuff, on the grounds that seeing it in a 
help message might prompt action.

The reasons for the two-line format are:

* A vague thought that splitting the docstring on the (first) #\Newline would 
give a short description suitable for the minibuffer or lists of commands; and

* Not including #\Newlines in the remainder of the string would encourage us 
to flow the text attractively across the available screen real-estate, 
whatever that might be in any particular case. (I find the Gnu Emacs docstring 
help presentation particularly ugly.)

As always, counter-arguments are welcome.

Cheers,
JQS