Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Establish consistent capitalization #95

Open
jayqi opened this issue Jan 14, 2020 · 1 comment
Open

Establish consistent capitalization #95

jayqi opened this issue Jan 14, 2020 · 1 comment

Comments

@jayqi
Copy link
Member

jayqi commented Jan 14, 2020

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.

@pjbull
Copy link
Member

pjbull commented Jan 16, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants