Skip to content

DOC: std() delta degree of freedom vs. degree of freedom #59405

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

Closed
1 task done
YudiXie opened this issue Aug 4, 2024 · 2 comments · Fixed by #59425
Closed
1 task done

DOC: std() delta degree of freedom vs. degree of freedom #59405

YudiXie opened this issue Aug 4, 2024 · 2 comments · Fixed by #59425
Assignees
Labels

Comments

@YudiXie
Copy link

YudiXie commented Aug 4, 2024

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/reference/api/pandas.core.groupby.DataFrameGroupBy.std.html#pandas.core.groupby.DataFrameGroupBy.std

Documentation problem

I think the ddof parameter should mean "Delta Degrees of Freedom" instead of "Degrees of freedom", which is a bit confusing since "Degrees of freedom" = N - "Delta Degrees of Freedom"

Suggested fix for documentation

change the documentation of ddof parameter to "Delta Degrees of Freedom". Like that of the numpy documentation: https://numpy.org/doc/stable/reference/generated/numpy.std.html

@YudiXie YudiXie added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Aug 4, 2024
@KevsterAmp
Copy link
Contributor

I'd like to work on this

@KevsterAmp
Copy link
Contributor

take

@rhshadrach rhshadrach removed the Needs Triage Issue that has not been reviewed by a pandas team member label Aug 5, 2024
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 a pull request may close this issue.

3 participants