From: Jeff King <peff@peff.net>
To: Philip Oakley <philipoakley@iee.org>
Cc: GitList <git@vger.kernel.org>
Subject: Re: [PATCH] doc: State coding guideline for error message punctuation
Date: Tue, 17 Jun 2014 05:37:59 -0400 [thread overview]
Message-ID: <20140617093759.GA6267@sigill.intra.peff.net> (raw)
In-Reply-To: <1402923357-3788-2-git-send-email-philipoakley@iee.org>
On Mon, Jun 16, 2014 at 01:55:57PM +0100, Philip Oakley wrote:
> +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.
Unlike Junio, I do not mind spelling out guidance for error messages.
However, I do not think the second sentence is adding anything here
(everything in CodingGuidelines is subject to "we did not always do it
this way, but this is the preferred way now"). So I'd drop it.
And then add in more guidance. Besides "no full stop", probably:
1. do not capitalize ("unable to open %s", not "Unable to open %s"
2. maybe something on sentence structure / ordering? We tend to prefer
"cannot open 'foo': No such file or directory" to "foo: cannot
open: No such file or directory".
Perhaps there are others (we do not have to be exhaustive, but it makes
sense to think for a moment while we are here).
-Peff
next prev parent reply other threads:[~2014-06-17 9:38 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 ` [PATCH] doc: State coding guideline for error message punctuation Philip Oakley
2014-06-16 18:52 ` Junio C Hamano
2014-06-16 19:57 ` Philip Oakley
2014-06-17 9:37 ` Jeff King [this message]
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=20140617093759.GA6267@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=philipoakley@iee.org \
/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).