Skip to content
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.

Sign up for GitHub

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

Jump to bottom

DOC: is confusing for ddof parameter of sem, var and std functions #18903

Closed
recontemplator opened this issue Dec 21, 2017 · 3 comments
Closed

DOC: is confusing for ddof parameter of sem, var and std functions #18903

recontemplator opened this issue Dec 21, 2017 · 3 comments
Labels
Docs good first issue Numeric Operations Arithmetic, Comparison, and Logical operations
Milestone
0.23.0

Comments

@recontemplator
Copy link

pandas/pandas/core/generic.py

Lines 7160 to 7161 in 7bb204a

ddof : int, default 1
degrees of freedom

It states that ddof is for degrees of freedom with default value of 1. But actually it is for "Delta degrees-of-freedom" (even the name of the parameter is abbreviation of that definition). The meaning is: how many degrees of freedom to adjust relative to the population size. Default of 1 - means we need to adjust by one, not use one as a value of degrees of freedom (thats makes no sense). All functions are worked as expected, but documentation on ddof parameter is confusing.
@sinhrks
Copy link
Member

sinhrks commented Dec 23, 2017

Yeah it should be fixed according to the latest numpy doc. PR is welcome!

https://docs.scipy.org/doc/numpy-1.13.0/reference/generated/numpy.std.html

@sinhrks sinhrks added the Docs label Dec 23, 2017
@jreback
Copy link
Contributor

jreback commented Dec 23, 2017

sure @recontemplator would you like to do a PR

@jreback jreback added Effort Low good first issue Numeric Operations Arithmetic, Comparison, and Logical operations labels Dec 23, 2017
@jreback jreback added this to the Next Major Release milestone Dec 23, 2017
@jreback jreback changed the title Documentation is confusing for ddof parameter of sem, var and std functions DOC: is confusing for ddof parameter of sem, var and std functions Dec 23, 2017
@butterflyskip
Copy link

Hi,
Newbie here, would like to take a stab at this.

txs

@alinde1 alinde1 mentioned this issue Mar 5, 2018
Merged
@jorisvandenbossche jorisvandenbossche modified the milestones: Next Major Release, 0.23.0 Mar 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs good first issue Numeric Operations Arithmetic, Comparison, and Logical operations
Projects
None yet
Milestone
0.23.0
Development

No branches or pull requests
5 participants
@jreback @jorisvandenbossche @sinhrks @recontemplator @butterflyskip