help-gnu-emacs
[Top][All Lists]
Advanced

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

Re: "First line is not a complete sentence" (was: Re: Emacs conventions


From: Joost Kremers
Subject: Re: "First line is not a complete sentence" (was: Re: Emacs conventions (was: Re: Overriding emacs key bindings))
Date: Thu, 02 Jun 2016 15:21:35 -0000
User-agent: slrn/1.0.1 (Linux)

Emanuel Berg wrote:
> But with docstrings, there is a wierd behavior
> - often, this is the "error":
>
>     First line is not a complete sentence
>
> What does that mean 

see (info "(elisp) Function Documentation"):

,----
|    The first line of the documentation string should stand on its own,
| because ‘apropos’ displays just this first line.  It should consist of
| one or two complete sentences that summarize the function’s purpose.
`----

> and what is the definition
> of a complete sentence - besides that it should
> end with a full stop?

Well, I suspect Emacs can only check whether it ends with a full stop,
but the idea is of course also that it is a full sentence from a
grammatical point of view. In essence, it should convey a clear and (in
the given context) unambiguous message.



-- 
Joost Kremers                                   address@hidden
Selbst in die Unterwelt dringt durch Spalten Licht
EN:SiS(9)


reply via email to

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