Re: doc-strings in src/ and the first line

[Stefan Monnier]

> 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