On 2021/07/09 11:41, Bharath Rupireddy wrote:
PSA v6 patch.
Thanks for updating the patch!
+ <simplesect>
+ <title>Avoid Using <quote>non-negative</quote> Word in Error
Messages</title>
+
+ <para>
+ Do not use <quote>non-negative</quote> word in error messages as it looks
+ ambiguous. Instead, use <quote>foo must be an integer value greater than
zero</quote>
+ or <quote>foo must be an integer value greater than or equal to
zero</quote>
+ if option <quote>foo</quote> expects an integer value.
+ </para>
+ </simplesect>
It seems suitable to put this guide under "Tricky Words to Avoid"
rather than adding it as separate section. Thought?
- if (nworkers < 1)
+ if (nworkers <= 0)
ereport(ERROR,
(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
- errmsg("number of workers must be a positive
integer")));
+ errmsg("number of workers must be an integer value
greater than zero")));
You replaced "positve" with "greater than zero". So the error message
style guide should mention not only "non-negative" but also "positive"
(probably also "negative") keyword?
If this is true, there are still many messages using "positive" or "negative"
keyword as follows. We should also fix them at all? Of course,
which would increase the change too big unnecessarily, I'm afraid, though..
src/backend/storage/ipc/signalfuncs.c: errmsg("\"timeout\"
must not be negative")));
src/backend/commands/functioncmds.c:
errmsg("COST must be positive")));
Regards,
--
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION
