How to begin an error/die string? Upper- or lower-case letter?

Lars Schneider· Dec 11, 2017, 10:23 UTC · lore

Hi,

error() and die() messages seems to begin with upper-case and lower-case letters in the Git code base:

  git grep 'error(_' | perl -nE 'say /.*error\(_\("(.).*/' | sort | uniq -c
  git grep 'die(_' | perl -nE 'say /.*die\(_\("(.).*/' | sort | uniq -c

Do we prefer one way over the other?

Thanks, Lars

Thomas Gummerer· Dec 11, 2017, 12:25 UTC · re: Lars Schneider · lore

Re: How to begin an error/die string? Upper- or lower-case letter?

On Mon, Dec 11, 2017 at 10:23 AM, Lars Schneider <larsxschneider@gmail.com> wrote:

Show 9 quoted lines

> Hi,
>
> error() and die() messages seems to begin with upper-case and
> lower-case letters in the Git code base:
>
>   git grep 'error(_' | perl -nE 'say /.*error\(_\("(.).*/' | sort | uniq -c
>   git grep 'die(_' | perl -nE 'say /.*die\(_\("(.).*/' | sort | uniq -c
>
> Do we prefer one way over the other?

The coding guidelines mandate not capitalizing error messages:

    $ git grep -A6 "Error Messages" Documentation/CodingGuidelines
    Documentation/CodingGuidelines:Error Messages
    Documentation/CodingGuidelines-
    Documentation/CodingGuidelines- - Do not end error messages with a
full stop.
    Documentation/CodingGuidelines-
    Documentation/CodingGuidelines- - Do not capitalize ("unable to
open %s", not "Unable to open %s")
    Documentation/CodingGuidelines-
    Documentation/CodingGuidelines- - Say what the error is first
("cannot open %s", not "%s: cannot open")

I guess those that are capitalized are just leftovers from before we had that guideline in place, or slipped through review.

> Thanks,
> Lars
>