-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
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
DOC: fix See Also constructs #26059
Conversation
@@ -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) |
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.
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. |
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.
left-over from the old docstring
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
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.