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

From: Junio C Hamano <gitster@pobox.com>
Date: Jun 16, 2014, 18:52 UTC
Message-ID: <xmqq8uowr8ki.fsf@gitster.dls.corp.google.com>
In-Reply-To: <1402923357-3788-2-git-send-email-philipoakley@iee.org>

Philip Oakley <philipoakley@iee.org> writes:

Show 7 quoted lines

> 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>
> ---

Hmmm.  Do we really need to spell everything out?

I would rather hope that we can rely on our contributors to know Git well enough to ask "git grep" after reading the "follow the style of existing and surrounding code" rule that governs the overall guideline.

Show 21 quoted lines

>  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