[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#50658: Error messages including function names violates coding conve
From: |
Stefan Kangas |
Subject: |
bug#50658: Error messages including function names violates coding conventions |
Date: |
Sat, 18 Sep 2021 07:54:26 -0700 |
Eli Zaretskii <eliz@gnu.org> writes:
>> • An error message should start with a capital letter but should not
>> end with a period.
>>
>> These cases are all flagged by checkdoc when it tries to enforce the
>> above convention.
>
> I think it's a bug in checkdoc: the error message text, which excludes
> the function name, fulfills the requirement.
While working on this, I realized that it is impossible to know if in
something like:
(error "frobnicator not available")
The 'frobnicator' part is a Lisp symbol (that can be in lower-case), or
if it is a regular word (that must be capitalized). It would obviously
be helpful if our conventions could be unambiguous.
Perhaps we could add a requirement here, something like: a Lisp symbol
must always be in `quotes', or behind ": "?
(I guess this would also affect the text we want to put in `(elisp)
Documentation Tips'.)
- bug#50658: Error messages including function names violates coding conventions, Stefan Kangas, 2021/09/18
- bug#50658: Error messages including function names violates coding conventions,
Stefan Kangas <=
- bug#50658: Error messages including function names violates coding conventions, Eli Zaretskii, 2021/09/18
- bug#50658: Error messages including function names violates coding conventions, Stefan Kangas, 2021/09/27
- bug#50658: Error messages including function names violates coding conventions, Eli Zaretskii, 2021/09/28
- bug#50658: Error messages including function names violates coding conventions, Stefan Kangas, 2021/09/28
- bug#50658: Error messages including function names violates coding conventions, Eli Zaretskii, 2021/09/28
- bug#50658: Error messages including function names violates coding conventions, Stefan Kangas, 2021/09/28