git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Philip Oakley <philipoakley@iee.org>
To: GitList <git@vger.kernel.org>
Cc: Jeff King <peff@peff.net>
Subject: [PATCH] doc: State coding guideline for error message punctuation
Date: Mon, 16 Jun 2014 13:55:57 +0100	[thread overview]
Message-ID: <1402923357-3788-2-git-send-email-philipoakley@iee.org> (raw)
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

  reply	other threads:[~2014-06-16 12:55 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-06-16 12:55 [PATCH] Coding guideline for Error messages Philip Oakley
2014-06-16 12:55 ` Philip Oakley [this message]
2014-06-16 18:52   ` [PATCH] doc: State coding guideline for error message punctuation Junio C Hamano
2014-06-16 19:57     ` Philip Oakley
2014-06-17  9:37   ` Jeff King
2014-07-10 20:36     ` Junio C Hamano
2014-07-10 20:42       ` Jeff King
2014-07-15 19:28       ` Philip Oakley

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1402923357-3788-2-git-send-email-philipoakley@iee.org \
    --to=philipoakley@iee.org \
    --cc=git@vger.kernel.org \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).