git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] doc: State coding guideline for error message punctuation

From
Philip Oakley <philipoakley@iee.org>
Date
Jun 16, 2014, 12:55 UTC
Message-ID
<1402923357-3788-2-git-send-email-philipoakley@iee.org>
In-Reply-To
<1402923357-3788-1-git-send-email-philipoakley@iee.org>
Clarify error message puntuation to reduce review workload [1].

[1] http://article.gmane.org/gmane.comp.version-control.git/251547 (see trailing 'nit' item).

Signed-off-by: Philip Oakley <philipoakley@iee.org>
---
 Documentation/CodingGuidelines | 7 +++++++
 1 file changed, 7 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 4d90c77..b2f3442 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -404,6 +404,13 @@ For Python scripts:
    documentation for version 2.6 does not mention this prefix, it has
    been supported since version 2.6.0.
 
+Error Messages
+
+ - We typically do not end error messages with a full stop. While
+   we've been rather inconsistent in the past, these days we mostly
+   settle on no punctuation.
+
+
 Writing Documentation:
 
  Most (if not all) of the documentation pages are written in the
-- 
1.9.4.msysgit.0
Previous: Philip OakleyNext: Junio C Hamano
Message 2 of 8 in “Coding guideline for Error messages”
  1. Coding guideline for Error messagesPhilip Oakley, Jun 16, 2014
  2. doc: State coding guideline for error message punctuationPhilip Oakley, Jun 16, 2014
  3. Junio C HamanoJun 16, 2014
  4. Philip OakleyJun 16, 2014
  5. Jeff KingJun 17, 2014
  6. Junio C HamanoJul 10, 2014
  7. Jeff KingJul 10, 2014
  8. Philip OakleyJul 15, 2014

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.