[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: doc-strings in src/ and the first line
From: |
Stefan Monnier |
Subject: |
Re: doc-strings in src/ and the first line |
Date: |
Tue, 13 Nov 2001 09:48:05 -0500 |
> Hi,
>
> as you probably know (and it is now explicitly mentioned in the Elisp
> Reference manual), the first line of the documentation string should stand
> on its own (this is exact citation ;-). While converting doc-strings to
> new syntax, I have fixed many simple and clear cases, but these
> remain. Any volunteer to go through them?
Note that if the first line ends with a punctuation like `,' or `;'
it might be OK, as long as that part of the text makes sense on its own
(with the `,' or `;' just indicating that there's more to it).
> ./buffer.c:5163: doc: /* Default value of
> `scroll-up-aggressively' for buffers that
> ./buffer.c:5169: doc: /* Default value of
> `scroll-down-aggressively' for buffers that
> ./buffer.c:5176: doc: /* Analogous to `mode-line-format',
> but for the mode line that can be
> ./buffer.c:5293: doc: /* *Non-nil means do not display
> continuation lines;
> ./buffer.c:5335: doc: /* Name of file for auto-saving
> current buffer,
> ./buffer.c:5352: doc: /* Non-nil enables selective display:
Those last three, for example look fine to me.
Stefan
- doc-strings in src/ and the first line, Pavel Janík, 2001/11/13
- Re: doc-strings in src/ and the first line,
Stefan Monnier <=
- Re: doc-strings in src/ and the first line, Richard Stallman, 2001/11/13
- Re: doc-strings in src/ and the first line, Eli Zaretskii, 2001/11/14
- Re: doc-strings in src/ and the first line, Richard Stallman, 2001/11/15
- Re: doc-strings in src/ and the first line, Eli Zaretskii, 2001/11/15
- Re: doc-strings in src/ and the first line, Richard Stallman, 2001/11/15
- Re[2]: doc-strings in src/ and the first line, Eric M. Ludlam, 2001/11/15
- Re: doc-strings in src/ and the first line, Eli Zaretskii, 2001/11/16