Skip to content

DOC: Do not mention private classes in the documentation #26997

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 23, 2019
Merged

DOC: Do not mention private classes in the documentation #26997

merged 4 commits into from
Jun 23, 2019

Conversation

LiXuanqi
Copy link
Contributor

@codecov
Copy link

codecov bot commented Jun 22, 2019

Codecov Report

Merging #26997 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #26997      +/-   ##
==========================================
- Coverage   91.99%   91.99%   -0.01%     
==========================================
  Files         180      180              
  Lines       50774    50774              
==========================================
- Hits        46711    46708       -3     
- Misses       4063     4066       +3
Flag Coverage Δ
#multiple 90.63% <ø> (ø) ⬆️
#single 41.85% <ø> (-0.07%) ⬇️
Impacted Files Coverage Δ
pandas/core/groupby/groupby.py 97.17% <ø> (ø) ⬆️
pandas/core/generic.py 94.2% <ø> (ø) ⬆️
pandas/io/gbq.py 88.88% <0%> (-11.12%) ⬇️
pandas/core/frame.py 96.89% <0%> (-0.12%) ⬇️
pandas/util/testing.py 90.94% <0%> (+0.1%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a14874f...09de96d. Read the comment docs.

@codecov
Copy link

codecov bot commented Jun 22, 2019 •
edited
Loading

Codecov Report

Merging #26997 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #26997      +/-   ##
==========================================
- Coverage   91.99%   91.99%   -0.01%     
==========================================
  Files         180      180              
  Lines       50774    50774              
==========================================
- Hits        46712    46708       -4     
- Misses       4062     4066       +4
Flag Coverage Δ
#multiple 90.63% <ø> (ø) ⬆️
#single 41.85% <ø> (-0.09%) ⬇️
Impacted Files Coverage Δ
pandas/core/groupby/groupby.py 97.17% <ø> (ø) ⬆️
pandas/core/generic.py 94.2% <ø> (ø) ⬆️
pandas/io/gbq.py 88.88% <0%> (-11.12%) ⬇️
pandas/core/frame.py 96.89% <0%> (-0.12%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b4d4ec5...de96c38. Read the comment docs.

jorisvandenbossche
jorisvandenbossche reviewed Jun 22, 2019
View reviewed changes
Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

pandas/core/generic.py Outdated
@@ -56,7 +56,7 @@
# able to share
_shared_docs = dict()
_shared_doc_kwargs = dict(
axes='keywords for axes', klass='NDFrame',
axes='keywords for axes', klass='DataFrame',
Copy link
Member

Choose a reason for hiding this comment

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

Inside this file (generic.py), I would replace all occurences of 'NDFrame' with "Series/DataFrame", since those docstrings might be shared by both Series and DataFrame

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will do!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jorisvandenbossche I have fixed the issue. How do you think?

@gfyoung gfyoung added the Docs label Jun 22, 2019
@jorisvandenbossche
Copy link
Member

Perfect! Thanks a lot

@jorisvandenbossche jorisvandenbossche merged commit cf74b02 into pandas-dev:master Jun 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jorisvandenbossche jorisvandenbossche jorisvandenbossche left review comments

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

DOC: Do not mention private classes in the documentation
3 participants
@LiXuanqi @jorisvandenbossche @gfyoung