auctex
[Top][All Lists]
Advanced

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

Re: [AUCTeX] Patch to tex-info.el to support node name completion in @..


From: Tassilo Horn
Subject: Re: [AUCTeX] Patch to tex-info.el to support node name completion in @..ref commands, and solve a few other pbs
Date: Tue, 27 Oct 2015 16:42:41 +0100
User-agent: Gnus/5.130014 (Ma Gnus v0.14) Emacs/25.0.50 (gnu/linux)

Joost Kremers <address@hidden> writes:

> On Di, Okt 27 2015, Tassilo Horn <address@hidden> 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




reply via email to

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