Skip to content

DOC: fix See Also constructs #26059

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

Conversation

jorisvandenbossche
Copy link
Member

I am testing the numpydoc master version (almost to be released as 0.9, see numpy/numpydoc#203), and it got a bit more strict on misformatted See Also sections. This PR fixes that.

@jorisvandenbossche jorisvandenbossche added this to the 0.25.0 milestone Apr 12, 2019
@@ -1097,7 +1097,8 @@ def count(self):
# defined here for API doc
raise NotImplementedError

@Substitution(name='groupby', see_also=_common_see_also)
@Substitution(name='groupby')
@Substitution(see_also=_common_see_also)
Copy link
Member Author

Choose a reason for hiding this comment

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

If done there are also %name occurences in the _common_see_also that need to be substituted, so they cannot be done in one go.

@@ -3625,7 +3625,6 @@ def values(self):
Index.array : Reference to the underlying data.
Index.to_numpy : A NumPy array representing the underlying data.

Return the underlying data as an ndarray.
Copy link
Member Author

Choose a reason for hiding this comment

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

left-over from the old docstring

@codecov
Copy link

codecov bot commented Apr 12, 2019

Codecov Report

Merging #26059 into master will decrease coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #26059      +/-   ##
==========================================
- Coverage    91.9%   91.89%   -0.01%     
==========================================
  Files         175      175              
  Lines       52485    52489       +4     
==========================================
  Hits        48234    48234              
- Misses       4251     4255       +4
Flag Coverage Δ
#multiple 90.45% <100%> (ø) ⬆️
#single 40.76% <100%> (-0.13%) ⬇️
Impacted Files Coverage Δ
pandas/core/indexes/base.py 96.79% <ø> (ø) ⬆️
pandas/core/groupby/groupby.py 97.23% <100%> (+0.01%) ⬆️
pandas/io/gbq.py 75% <0%> (-12.5%) ⬇️
pandas/core/frame.py 96.79% <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 a07ed59...45cb0ae. Read the comment docs.

@codecov
Copy link

codecov bot commented Apr 12, 2019

Codecov Report

Merging #26059 into master will decrease coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #26059      +/-   ##
==========================================
- Coverage    91.9%   91.89%   -0.01%     
==========================================
  Files         175      175              
  Lines       52485    52489       +4     
==========================================
  Hits        48234    48234              
- Misses       4251     4255       +4
Flag Coverage Δ
#multiple 90.45% <100%> (ø) ⬆️
#single 40.76% <100%> (-0.13%) ⬇️
Impacted Files Coverage Δ
pandas/core/indexes/base.py 96.79% <ø> (ø) ⬆️
pandas/core/groupby/groupby.py 97.23% <100%> (+0.01%) ⬆️
pandas/io/gbq.py 75% <0%> (-12.5%) ⬇️
pandas/core/frame.py 96.79% <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 a07ed59...35138d4. Read the comment docs.

@jorisvandenbossche jorisvandenbossche merged commit feefca8 into pandas-dev:master Apr 12, 2019
@jorisvandenbossche jorisvandenbossche deleted the doc-numpydoc-update branch April 12, 2019 14:36
yhaque1213 pushed a commit to yhaque1213/pandas that referenced this pull request Apr 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant