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

Ambiguous Documentation #6

Open
rmlopes opened this issue Aug 13, 2019 · 0 comments
Open

Ambiguous Documentation #6

rmlopes opened this issue Aug 13, 2019 · 0 comments

Comments

@rmlopes
Copy link

rmlopes commented Aug 13, 2019 •
edited

The documentation for the Holm method, or instance, is a bit ambiguous.

The function signature:
stac.nonparametric_tests.holm_test(ranks, control=None)

The parameters documentation:

Parameters: | pivots : dictionary_like - A dictionary with format ‘groupname’:’pivotal quantity’

The Friedman test returns both pivots and ranks. The parameter should be renamed in the function signature.
@rmlopes rmlopes changed the title Documentation confusion Ambiguous Documentation Aug 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rmlopes