Skip to content

Establish consistent capitalization #95

@jayqi

Description

@jayqi

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions