DOC: Fix SA04 errors in docstrings #28792 #32182
Conversation
pandas/core/base.py
Outdated
| @@ -942,7 +942,8 @@ def argmax(self, axis=None, skipna=True, *args, **kwargs): | |||
|
|
|||
| See Also | |||
| -------- | |||
| numpy.ndarray.argmax | |||
There was a problem hiding this comment.
@datapythonista is this a convention we're moving to?
There was a problem hiding this comment.
Hmm yea can be pretty repetitive /tedious but I don’t think there’s a way around it with the current docstring validation unless @datapythonista knows otherwise
There was a problem hiding this comment.
In this case my preference would be to leverage the context of the page we are in, and have as a description something like "Same function for numpy arrays.".
But I personally think that it adds value to have the elements in the see also, and a short comment on why they are related. I'm thinking on a new user visiting head, and how helpful it can be to know that a tail method exists, and that it "does the same as head but from the end of the dataframe".
Would you prefer to not have the descriptions?
|
@AdrianMastronardi looks like a merge conflict - can you merge master? |
|
@WillAyd merge conflict resolved. |
|
Great thanks @AdrianMastronardi ! |
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diff