doc: give some guidelines for error messages

Clarify error message puntuation to reduce review workload.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
Helped-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Philip Oakley 2014-06-16 13:55:57 +01:00 committed by Junio C Hamano
parent 9a597edc83
commit 0ae0e882b2
1 changed files with 9 additions and 0 deletions

View File

@ -264,6 +264,15 @@ For Python scripts:
documentation for version 2.6 does not mention this prefix, it has
been supported since version 2.6.0.

Error Messages

- Do not end error messages with a full stop.

- Do not capitalize ("unable to open %s", not "Unable to open %s")

- Say what the error is first ("cannot open %s", not "%s: cannot open")


Writing Documentation:

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