You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The docs for pd.DataFrame.max() state, about the axis argument:
axis{index (0), columns (1)}
Axis for the function to be applied on.
The docs for pd.DataFrame.std() don't even include the explanatory sentence.
Instead, the docs for pd.DataFrame.cummin() have
axis{0 or ‘index’, 1 or ‘columns’}, default 0
The index or the name of the axis. 0 is equivalent to None or ‘index’.
... which I think is good (also notice the more understandable explanation of the equivalence between numbers and descriptions), except that the default in the signature is None, not 0, and that I would replace the last sentence with None is equivalent to 0 or index.
Suggested fix for documentation
Simplest solution: specify, in all these signatures, that default: Noneand that None corresponds to 0 (see above for cummin()).
My preferred solution, set the default to 0 (rather than None), specify that default 0, start deprecating None (which is likely not used anywhere anyway). But given that the current max() signature states axis=NoDefault.no_default, which I don't know the meaning of, maybe there is something I am missing? Still, the signature for std() looks similar except that axis=None (the axis docs still provide no default), and conceptually the kind of requested data manipulation is similar...
The text was updated successfully, but these errors were encountered:
Pandas version checks
main
hereLocation of the documentation
https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.max.html
Documentation problem
The docs for
pd.DataFrame.max()
state, about theaxis
argument:The docs for
pd.DataFrame.std()
don't even include the explanatory sentence.Instead, the docs for
pd.DataFrame.cummin()
have... which I think is good (also notice the more understandable explanation of the equivalence between numbers and descriptions), except that the default in the signature is
None
, not0
, and that I would replace the last sentence withNone is equivalent to 0 or index
.Suggested fix for documentation
Simplest solution: specify, in all these signatures, that
default: None
and thatNone
corresponds to 0 (see above forcummin()
).My preferred solution, set the default to 0 (rather than
None
), specify thatdefault 0
, start deprecatingNone
(which is likely not used anywhere anyway). But given that the currentmax()
signature statesaxis=NoDefault.no_default
, which I don't know the meaning of, maybe there is something I am missing? Still, the signature forstd()
looks similar except thataxis=None
(theaxis
docs still provide no default), and conceptually the kind of requested data manipulation is similar...The text was updated successfully, but these errors were encountered: