DOC: Fix capitalization of the word pandas in the docs #32439
Conversation
There was a problem hiding this comment.
Looks good.
What would be nice is to have a check in ci/code_checks.sh that greps for Pandas or *pandas* and fails if any occurrence is found. We do this for several patterns, you can use them as reference. Ideally we'd like to check at least all the rst in doc/andweb/`.
| @@ -1272,9 +1272,9 @@ Running the performance test suite | |||
| ---------------------------------- | |||
|
|
|||
| Performance matters and it is worth considering whether your code has introduced | |||
| performance regressions. *pandas* is in the process of migrating to | |||
| performance regressions. pandas is in the process of migrating to | |||
There was a problem hiding this comment.
Do you mind leaving just one space before pandas
| @@ -1386,7 +1386,7 @@ Doing 'git status' again should give something like:: | |||
| # modified: /relative/path/to/file-you-added.py | |||
| # | |||
|
|
|||
| Finally, commit your changes to your local repository with an explanatory message. *Pandas* | |||
| Finally, commit your changes to your local repository with an explanatory message. Pandas | |||
There was a problem hiding this comment.
pandas in lower case, also, just leave one space before pandas.
| @@ -1434,7 +1434,7 @@ like:: | |||
| upstream git://github.com/pandas-dev/pandas.git (fetch) | |||
| upstream git://github.com/pandas-dev/pandas.git (push) | |||
|
|
|||
| Now your code is on GitHub, but it is not yet a part of the *pandas* project. For that to | |||
| Now your code is on GitHub, but it is not yet a part of the pandas project. For that to | |||
There was a problem hiding this comment.
one space only after the period
datapythonista
changed the title
|
@datapythonista , sure I'll add the checks and update the required changes, I should add the checks in a separate PR right? |
You can add them here or in a separate PR, as you prefer. Not sure how many cases will still fail, if there are lots, probably better to open a new PR, so the PR is not so big. |
|
@joybhallaa do you have time to add the checks and fix the CI? |
|
Yes! |
|
|
||
| pandas uses 'type(foo)' instead 'foo.__class__' as it is making the code more |
There was a problem hiding this comment.
next time please avoid side changes, like makes -> is making here.
|
Thanks @joybhallaa |
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diffAs stated in the referred issue, pandas reference in the docs should be standardised to pandas, not pandas or Pandas.
I've only changed the references in
doc/source/development/*.rstfor now, to see if the changes are okay or not