DOC: Updated the returns for DataFrame.any/all to return either a Series or scalar #57817
Conversation
sammig6i
changed the title
sammig6i
changed the title
|
/preview |
|
Website preview of this PR available at: https://pandas.pydata.org/preview/pandas-dev/pandas/57817/ |
| {name1} or {name2} | ||
| If level is specified, then, {name2} is returned; otherwise, {name1} | ||
| {name1} or scalar | ||
| If axis=None, then a scalar boolean is returned. Otherwise, a {name1} is returned with index matching the index argument. |
There was a problem hiding this comment.
There shouldn't be a period at the end. See how it renders here: https://pandas.pydata.org/preview/pandas-dev/pandas/57817/docs/reference/api/pandas.Series.any.html#pandas.Series.any
Also, the type is scalar or scalar. I think this already happens in the docs, but since you are already changing this, maybe worth leaving it well.
Also note that while the discussion is not settle, people seems to be happy to stop reusing docstrings. So if you want to replicate the docstring for each method, that would be ok.
|
@sammig6i do you mind having a look at #57682 and see if the changes here conflict with the changes there please? I think you're modifying the same exact part of the documentation, and if that's the case it's probably better to discontinue this one (feel free to provide any feedback to that PR). Thanks! |
|
Closing, as this seems to be duplicated and stale. |
#57088
updated documentation for reflect the return types for Dataframe.any/all calls.