Skip to content

Commit 0ae0e88

Browse files
Philip Oakleygitster
authored andcommitted
doc: give some guidelines for error messages
Clarify error message puntuation to reduce review workload. Signed-off-by: Philip Oakley <[email protected]> Helped-by: Jeff King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 9a597ed commit 0ae0e88

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Documentation/CodingGuidelines

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,15 @@ For Python scripts:
264264
documentation for version 2.6 does not mention this prefix, it has
265265
been supported since version 2.6.0.
266266

267+
Error Messages
268+
269+
- Do not end error messages with a full stop.
270+
271+
- Do not capitalize ("unable to open %s", not "Unable to open %s")
272+
273+
- Say what the error is first ("cannot open %s", not "%s: cannot open")
274+
275+
267276
Writing Documentation:
268277

269278
Most (if not all) of the documentation pages are written in the

0 commit comments

Comments
 (0)