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

[DOC]: Revert official project name from "XCDAT" to "xCDAT" #228

Closed
tomvothecoder opened this issue Apr 26, 2022 · 0 comments · Fixed by #231
Closed

[DOC]: Revert official project name from "XCDAT" to "xCDAT" #228

tomvothecoder opened this issue Apr 26, 2022 · 0 comments · Fixed by #231
Assignees
Labels
type: docs Updates to documentation

Comments

@tomvothecoder
Copy link
Collaborator

tomvothecoder commented Apr 26, 2022

Describe your documentation update

Reasons to use "xCDAT":

  • It sounds like it xarray + CDAT capabilities
  • Some folks have already been referring to this project as "xCDAT"
  • Names of xarray related packages seem to usually start with a lower case "x" (e.g., "xEMSF")

Reasons to use "XCDAT"

  • Grammatically incorrect since it is technically an acronym
  • Might be less readable to some

Next Steps

We are leaning towards "xCDAT".

  • Official project name: "xCDAT" (not strict if users use "XCDAT")
  • Python package name: "xcdat"
  • Update "xCDAT" logo with smaller "x"

Related xarray issue related to its name: pydata/xarray#1306

“Yes, this is a little silly, but do we have a preferred capitalization for the proper name?

We mostly stick to ‘xarray’ in the docs but ‘Xarray’ or ‘XArray’ is arguably a little more readable and grammatically correct.”

“I like xarray because it is the same as the python package. However, for aesthetic reasons I capitalize Xarray when used for titles or at the beginning of a sentence...”

“Closing this. We use "xarray" in the middle of sentences and "Xarray" at the start but aren't that strict about it.

Yes: Xarray (at start of sentences), xarray (in middle)
No: XArray, xArray”

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

Successfully merging a pull request may close this issue.

1 participant