Re: [AUCTeX] Patch to tex-info.el to support node name completion in @..ref commands, and solve a few other pbs

[David Kastrup]

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. (Well, that's to say,
> I don't always do this in my Elisp files and flycheck never complains
> about it... ;-)

The entire DOC string should mention all parameters in order.  The "in
order" criterion does not make a whole lot of sense to me really since
the order of parameters is often determined by technical considerations
rather than how one would like to arrange a DOC string grammatically,
but there you are.

-- 
David Kastrup