Joost Kremers <joostkrem...@fastmail.fm> writes:

> On Di, Okt 27 2015, Tassilo Horn <t...@gnu.org> wrote:
>> A bit too long given that the first sentence of a docstring should fit
>> into one line and still mention all parameters.
>
> Just a nit pick, but AFAIK the convention is that the first line
> should summarise what the function does, but there is no requirement
> that it also mentions all variables that a function takes.

Right, but in general that goes hand in hand with the "main" parameters,
e.g., with `pushnew' X and PLACE are surely relevant for such a summary
whereas the additional keyword arguments it takes are not.

Bye,
Tassilo


_______________________________________________
auctex mailing list
auctex@gnu.org
https://lists.gnu.org/mailman/listinfo/auctex

Reply via email to