[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: "First line is not a complete sentence" (was: Re: Emacs conventions
Re: "First line is not a complete sentence" (was: Re: Emacs conventions (was: Re: Overriding emacs key bindings))
Thu, 19 May 2016 06:32:56 +0200
Gnus/5.13 (Gnus v5.13) Emacs/24.4 (gnu/linux)
Joost Kremers <address@hidden>
> 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
That was I joke which refered to that the error
message itself wasn't a full sentence :)
Because I get that error even tho there is
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.
Right, but if it cannot check that, it might as
well *always* report "Use correct English!"
No, I think it does something more sensible,
only it fails to communicate what exactly so it
is only confusing at this point.
Wait... now I understand, I think. One gets the
error if one ends the first line with \n!
underground experts united .... http://user.it.uu.se/~embe8573
Emacs Gnus Blogomatic ......... http://user.it.uu.se/~embe8573/blogomatic
- so far: 33 Blogomatic articles -