conda-docs icon indicating copy to clipboard operation
conda-docs copied to clipboard

conda capitalization standards should be explained somewhere in docs

Open kathatherine opened this issue 2 years ago • 4 comments

Creating this ticket to figure out the capitalization standards for conda and explain it somewhere in the docs, so we have something to point to when enforcing those rules. I've heard the following sets of rules, which contradict each other a little:

  • conda should only be capitalized when at the front of a sentence

or

  • conda should be lowercase when talking about the command and uppercase when talking about the program (and also uppercase at the beginning of a sentence) (Bad tech writing example to illustrate all cases - "Conda is great. Conda uses the conda command. You can use the Conda package manager to install a package with conda install PACKAGE")

Obviously, the second one is more complex, but it's what I've seen more in Anaconda docs about conda. We should make sure Anaconda and the community are aligned with how we talk about conda/Conda.

kathatherine avatar Jun 16 '22 15:06 kathatherine

In my brain, I really want to capitalize Conda when writing about it. I have to fight that every day. So, I would lean towards capitalizing everything but the command itself.

tnabtaf avatar Jun 16 '22 16:06 tnabtaf

I think we should amend the naming convention and just follow Git's standard. It's eighter "Git" or git, nothing in between.

So "Conda" or conda, nothing in between. So if we are talking about Conda it's unstyled and titlecase and only if we are showing command examples (e.g. conda info) do we stylize and lowercase.

(edit) @kathatherine's second option, I got too excited and didn't finish reading 🤦‍♂️

kenodegard avatar Jun 16 '22 18:06 kenodegard

There was a prior discussion/convo that is should be lowercase but that doesn't mean it couldn't change. I agree there should be alignment around it. In my view knowing that conda should always be lowercase no matter the scenario is simpler. A command is conda and discussing the project is conda.

This will no doubt be the most voted-on issue in C/conda's history 😆

LtDan33 avatar Jun 27 '22 21:06 LtDan33

Working on a CEP for this: https://github.com/conda-incubator/ceps/pull/31

kathatherine avatar Jul 20 '22 15:07 kathatherine

Closed via https://github.com/conda-incubator/ceps/pull/35.

jezdez avatar Aug 30 '22 08:08 jezdez