Skip to content

DOC: document default axis=0 on DataFrame reductions#65634

Merged
mroeschke merged 1 commit into
pandas-dev:mainfrom
jbrockmendel:doc-3
May 16, 2026
Merged

DOC: document default axis=0 on DataFrame reductions#65634
mroeschke merged 1 commit into
pandas-dev:mainfrom
jbrockmendel:doc-3

Conversation

@jbrockmendel
Copy link
Copy Markdown
Member

closes #48561

Summary

  • Adds , default 0 to the axis parameter doc line on DataFrame.min/max/sum/prod/mean/median/sem/var/std/skew/kurt (the signature default is already 0).
  • Restores the missing Axis for the function to be applied on. description on sem, var, and std, where a .. warning:: block immediately followed the type spec.

Cum-methods (cummin/cummax/cumsum/cumprod) already had default 0 and are left alone.

Test plan

  • help(pd.DataFrame.std) renders the corrected docstring
  • pre-commit hooks pass

Adds ", default 0" to the axis parameter line and restores the
"Axis for the function to be applied on." description on std/var/sem
(which had a `.. warning::` block immediately after the type spec).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@mroeschke mroeschke added the Docs label May 16, 2026
@mroeschke mroeschke added this to the 3.1 milestone May 16, 2026
@mroeschke mroeschke merged commit 9993ce6 into pandas-dev:main May 16, 2026
51 checks passed
@mroeschke
Copy link
Copy Markdown
Member

Thanks @jbrockmendel

@jbrockmendel jbrockmendel deleted the doc-3 branch May 17, 2026 02:33
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.

DOC: default axis is unspecified for DataFrame (and even some Series) operations

2 participants