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.

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

DOC: stats: update formulas given for kstat/kstatvar to reflect implementations #20746

Merged
merged 5 commits into from
May 21, 2024

Conversation

j-bowhay
Copy link
Member

Reference issue

#20634 (review)

What does this implement/fix?

Updates formulas to match implementation and cross-referenced against https://mathworld.wolfram.com/k-Statistic.html

Additional information

@j-bowhay j-bowhay requested a review from mdhaber May 19, 2024 08:54
@github-actions github-actions bot added scipy.stats Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels May 19, 2024
Copy link
Contributor

@mdhaber mdhaber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Here's the rendered documentation:

https://output.circle-artifacts.com/output/job/aa2f84d1-4da6-4f02-b88f-561c8eff1588/artifacts/0/html/reference/generated/scipy.stats.kstat.html#scipy.stats.kstat

I'd be happy to also review obvious improvements to the formatting of the extended summary, references, and example if you'd like to make them.

scipy/stats/_morestats.py Outdated Show resolved Hide resolved
scipy/stats/_morestats.py Outdated Show resolved Hide resolved
j-bowhay and others added 2 commits May 21, 2024 10:12
[skip ci]

Co-authored-by: Matt Haberland <mhaberla@calpoly.edu>
[docs only]
same number (although they aren't identical). In the case of the normal
distribution, they converge to zero.

>>> for n in [2, 3, 4, 5, 6, 7]:
... x = rng.normal(size=10**n)
>>> for i in range(2,8):
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of n here to change the size seemed confusing because n also denoted the nth moment

scipy/stats/_morestats.py Outdated Show resolved Hide resolved
[skip ci]

Co-authored-by: Matt Haberland <mhaberla@calpoly.edu>
@mdhaber mdhaber merged commit e4b1a55 into scipy:main May 21, 2024
@mdhaber
Copy link
Contributor

mdhaber commented May 21, 2024

Thanks @j-bowhay!

@lucascolley lucascolley added this to the 1.14.0 milestone May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.stats
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants