procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve coding conventions for error messages

Browse source 
* doc/lispref/tips.texi (Programming Tips): Clarify coding
conventions for error messages to say that an error message can
start with a Lisp symbol.  (Bug#50658)
This commit is contained in:
Stefan Kangas 2021-09-28 14:56:07 +02:00
parent a5b8140d4e
commit e9c7ef3348
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/lispref/tips.texi
View file

@ -393,7 +393,13 @@ Don't use @code{message}, @code{throw}, @code{sleep-for}, or
@item
An error message should start with a capital letter but should not end
with a period.
with a period or other punctuation.
It is occasionally useful to tell the user where an error originated,
even if @code{debug-on-error} is nil. In such cases, a lower-case
Lisp symbol can be prepended to the error message. For example, the
error message ``Invalid input'' could be extended to say
``some-function: Invalid input''.
@item
A question asked in the minibuffer with @code{yes-or-no-p} or