Skip to content

DOC: Fix capitalization of the word pandas in the docs #32439

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

Merged
merged 3 commits into from
Mar 12, 2020

Conversation

joybh98
Copy link
Contributor

@joybh98 joybh98 commented Mar 4, 2020

As 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/*.rst for now, to see if the changes are okay or not

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one space only after the period

@datapythonista datapythonista changed the title standardise pandas refrences DOC: Fix capitalization of the word pandas in the docs Mar 5, 2020
@joybh98
Copy link
Contributor Author

joybh98 commented Mar 5, 2020

@datapythonista , sure I'll add the checks and update the required changes, I should add the checks in a separate PR right?

@datapythonista
Copy link
Member

@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.

@datapythonista
Copy link
Member

@joybhallaa do you have time to add the checks and fix the CI?

@joybh98
Copy link
Contributor Author

joybh98 commented Mar 10, 2020

Yes!

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, lgtm


pandas uses 'type(foo)' instead 'foo.__class__' as it is making the code more
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

next time please avoid side changes, like makes -> is making here.

@WillAyd WillAyd added this to the 1.1 milestone Mar 12, 2020
@WillAyd WillAyd merged commit f3859cb into pandas-dev:master Mar 12, 2020
@WillAyd
Copy link
Member

WillAyd commented Mar 12, 2020

Thanks @joybhallaa

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Standardize references to pandas in the documentation
3 participants