drivendataorg / drivendataorg/deon

Establish consistent capitalization

Open
#95 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
309
Forks
60
PR merge metrics
No merged PRs in 30d

Description

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](https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Trademarks#Trademarks_that_begin_with_a_lowercase_letter) would suggest uppercasing.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.