-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: Updating capitalization in folder doc/source/reference #32824
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: Updating capitalization in folder doc/source/reference #32824
Conversation
cleconte987
commented
Mar 19, 2020
•
edited by datapythonista
Loading
edited by datapythonista
- xref Fix capitalization among headings in documentation files #32550
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this @cleconte987, looks great.
What would be very useful is to add the files that are fixed to https://github.com/pandas-dev/pandas/blob/master/ci/code_checks.sh#L330, so no more errors are being introduced in those fails (the CI will fail and let us know if any PR introduces titles capitalized incorrectly).
If you can add it to this PR that would be great.
Ok I will work on that!
… Le 19 mars 2020 à 16:20, Marc Garcia ***@***.***> a écrit :
@datapythonista approved this pull request.
Thanks for working on this @cleconte987, looks great.
What would be very useful is to add the files that are fixed to https://github.com/pandas-dev/pandas/blob/master/ci/code_checks.sh#L330, so no more errors are being introduced in those fails (the CI will fail and let us know if any PR introduces titles capitalized incorrectly).
If you can add it to this PR that would be great.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or unsubscribe.
|
Thanks @cleconte987, changes look great. But looks like there are still several errors in that directory. Most of them need to be added here: https://github.com/pandas-dev/pandas/blob/master/scripts/validate_rst_title_capitalization.py#L20 Do you mind adding them, and fixing the cases that need it, if any? Thanks! |
…nt words with multiple capital letters
…t_modification Merging new changes from pandas-dev/pandas repository into script_modification to be up-to-date
Merge remote-tracking branch 'upstream_main_pandas/master' into script_modification
… add elements to exceptions's set in scripts/validate_rst_title_capitalization.py
Merge branch 'script_modification' into changes_to_pandas_remote
…' into changes_to_pandas_remote
Hello @cleconte987! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found: There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻 Comment last updated at 2020-03-27 07:48:21 UTC |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really nice, not sure about one of the cases, but other than that looks great.
doc/source/reference/series.rst
Outdated
@@ -110,7 +110,7 @@ Binary operator functions | |||
Series.product | |||
Series.dot | |||
|
|||
Function application, groupby & window | |||
Function application, GroupBy & window |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the reason for this one? Just my opinion, but I think this one was correct, and we don't want to capitalize groupy
to GroupBy
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I might have wrongly seen it with capital letters or something, re-updating PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see your point. to me it feels that there is the class GroupBy
, but here it's not talking about the class, but about the concept. I guess we can use group by
or groupping by
to disambiguate. But not that important, we can merge it like this and change it later if we think that makes sense.
Merge remote-tracking branch 'upstream_main_pandas/master' into changes_to_pandas_remote
Ok.. again failures in the PR sorry for that. I know now why I putted "GroupBy" as an exception. Because it is written like that in title in file doc/source/reference/groupby.rst |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, nice work.
doc/source/reference/series.rst
Outdated
@@ -110,7 +110,7 @@ Binary operator functions | |||
Series.product | |||
Series.dot | |||
|
|||
Function application, groupby & window | |||
Function application, GroupBy & window |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see your point. to me it feels that there is the class GroupBy
, but here it's not talking about the class, but about the concept. I guess we can use group by
or groupping by
to disambiguate. But not that important, we can merge it like this and change it later if we think that makes sense.
Thank you. Yes I understand now for the case of "groupby/GroupBy", but yeah it was not passing the tests then. Ok :) |
@cleconte987 can you merge upstream master to resolve conflicts |
I guess everything that this PR was proposing has already been fixed in master, since no changes appear in the diff. Closing, let me know if that's not correct @cleconte987, happy to reopen this is the problem is another one. |
No everything was updated, indeed! |