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.{circmean, circvar, circstd}: improve accuracy/clarity #20726

Merged
merged 6 commits into from
May 21, 2024

Conversation

fancidev
Copy link
Contributor

@fancidev fancidev commented May 16, 2024

Reference issue

Toward gh-20240.

What does this implement/fix?

Improves the accuracy and/or clarity of the doc of the circmean, circvar, and circstd functions.

@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 16, 2024
@j-bowhay
Copy link
Member

Friendly reminder that for documentation-only PRs we can save some compute by adding [docs only] to the commit message
https://docs.scipy.org/doc/scipy/dev/contributor/continuous_integration.html#skipping

@fancidev fancidev changed the title DOC: refine doc of scipy.stats.circmean DOC: refine doc of scipy.stats.circmean, circvar and circstd May 16, 2024
@fancidev
Copy link
Contributor Author

@dschmitz89 If you could take a look when you have time it would be great!

@lucascolley lucascolley changed the title DOC: refine doc of scipy.stats.circmean, circvar and circstd DOC: stats.{circmean, circvar, circstd}: improve accuracy/clarity May 18, 2024
[docs only]
@dschmitz89
Copy link
Contributor

Thanks for the PR @fancidev . This looks good to me. Could you add a reference, for example Wikipedia? Then I would merge.

@fancidev
Copy link
Contributor Author

Thanks for the PR @fancidev . This looks good to me. Could you add a reference, for example Wikipedia? Then I would merge.

Thanks for taking a look @dschmitz89 ! Let me locate the definition of those functions in Mardia and Jupp (1999) and add references accordingly.

@fancidev
Copy link
Contributor Author

Reference added! @dschmitz89

@dschmitz89
Copy link
Contributor

Thanks @fancidev .

@dschmitz89 dschmitz89 merged commit c2fccd3 into scipy:main May 21, 2024
28 of 29 checks passed
@lucascolley lucascolley added this to the 1.14.0 milestone May 21, 2024
@fancidev
Copy link
Contributor Author

Thank you @dschmitz89 !

@fancidev fancidev deleted the circ-docs branch May 22, 2024 13:43
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

4 participants