Skip to content

DOC: Standardize references to pandas in the documentation #32316

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

Closed
mroeschke opened this issue Feb 28, 2020 · 10 comments · Fixed by #32439, echozzy629/pandas_CPTS581#4 or #36845
Closed

DOC: Standardize references to pandas in the documentation #32316

mroeschke opened this issue Feb 28, 2020 · 10 comments · Fixed by #32439, echozzy629/pandas_CPTS581#4 or #36845

Comments

@mroeschke
Copy link
Member

mroeschke commented Feb 28, 2020

In our documentation (files in doc/source/../*.rst), we refer to pandas as Pandas, pandas, and *pandas* (sphinx italics).

For documentation consistency, we should standardize these to one form. pandas is the preferable form in our documentation files.

Unfortunately I don't think we create a lint rule for this pattern since we have to be flexible to references and hyperlinks.

@joybh98
Copy link
Contributor

joybh98 commented Feb 28, 2020

Can I take this issue?

@ShaharNaveh
Copy link
Member

Can I take this issue?

@joybhallaa Sure!
You can do this by commenting the word take (and nothing else, just the word take), and the github bot will assign this issue to you.

@joybh98
Copy link
Contributor

joybh98 commented Feb 28, 2020

take

@jorisvandenbossche
Copy link
Member

We could also decide to just use "pandas" instead of "pandas" (no italic), that's one thing less that you can forget to do.

@mroeschke
Copy link
Member Author

Good point @jorisvandenbossche. I'd prefer pandas as well for that reason. Will update the original post

@mroeschke
Copy link
Member Author

#32439 only fixed the references for development/*.rst

@willie3838
Copy link
Contributor

take

@EllieLockhart
Copy link

take

@LeviMatus
Copy link
Contributor

take

@Mikhaylov-yv
Copy link
Contributor

take

LeviMatus added a commit to LeviMatus/pandas that referenced this issue Oct 3, 2020
changes references to the library, pandas, to match
the standard lowercase spelling.

See also: pandas-dev#32316
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment