deon icon indicating copy to clipboard operation
deon copied to clipboard

Establish consistent capitalization

Open jayqi opened this issue 5 years ago • 1 comments

There are inconsistent stylings of deon lowercase and Deon uppercase throughout the documentation. There should be an agreed-upon styling, and the other way should be fixed.

As for considerations:

  • deon lowercase will look like the CLI and the logo.
  • Deon uppercase will look less weird when used in prose, especially at the beginning of a sentence

There are examples of other command-line programs adopting either styling:

  • grep, pip
  • Git, Vim, Emacs, Conda

Other option is to use deon lowercase everywhere, except when beginning a sentence. Deon is uppercase at the start of a sentence. This is kind of a cop-out, which avoids some awkwardness, but ends up with inconsistency.

Personally, I'm in favor of uppercase Deon, because I really don't like the weird sentence beginnings. I could also go with the lowercase-except-sentence-beginning.

FWIW, the Wikipedia Style Guide would suggest uppercasing.

jayqi avatar Jan 14 '20 06:01 jayqi

I don't feel strongly. Uppercasing is fine with me, but I don't promise to always do so throughout my tweets, presentations, slack messages and other communiques.

pjbull avatar Jan 16 '20 02:01 pjbull