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

conda capitalization standards should be explained somewhere in docs #803

Closed
kathatherine opened this issue Jun 16, 2022 · 5 comments
Closed
Assignees
Labels
in-progress issue is actively being worked on locked [bot] locked due to inactivity pending::discussion contains some ongoing discussion that needs to be resolved prior to proceeding source::anaconda created by members of Anaconda, Inc. type::documentation request for improved documentation

Comments

@kathatherine
Copy link
Contributor

kathatherine commented Jun 16, 2022

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.

@tnabtaf
Copy link

tnabtaf commented Jun 16, 2022

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.

@kenodegard
Copy link
Contributor

kenodegard commented Jun 16, 2022

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 kenodegard added source::anaconda created by members of Anaconda, Inc. type::documentation request for improved documentation backlog issue has been triaged but has not been earmarked for any upcoming release pending::discussion contains some ongoing discussion that needs to be resolved prior to proceeding labels Jun 16, 2022
@LtDan33
Copy link
Member

LtDan33 commented Jun 27, 2022

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 😆

@kathatherine
Copy link
Contributor Author

Working on a CEP for this: conda/ceps#31

@LtDan33 LtDan33 added in-progress issue is actively being worked on and removed backlog issue has been triaged but has not been earmarked for any upcoming release labels Jul 27, 2022
@jezdez
Copy link
Member

jezdez commented Aug 30, 2022

Closed via conda/ceps#35.

@jezdez jezdez closed this as completed Aug 30, 2022
@github-actions github-actions bot added the locked [bot] locked due to inactivity label Aug 31, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
in-progress issue is actively being worked on locked [bot] locked due to inactivity pending::discussion contains some ongoing discussion that needs to be resolved prior to proceeding source::anaconda created by members of Anaconda, Inc. type::documentation request for improved documentation
Projects
Archived in project
Development

No branches or pull requests

5 participants