Add a correction keyword to the std methods
#183
Conversation
| correction | ||
| Correction to apply to the result. 0 for sample standard deviation | ||
| and 1 for population standard deviation. |
There was a problem hiding this comment.
If we're only supporting 0 or 1 can this just be an int for now? We could change to allow floats later if desired?
There was a problem hiding this comment.
I think the description is misleading here. The 0 and 1 references are, tmk, to help users identify common correction values. See the Array API specification for a more extensive description.
There was a problem hiding this comment.
Should we "borrow" the docstring from the Array API specification then?
There was a problem hiding this comment.
Fine with me, but up to Marco. :)
There was a problem hiding this comment.
I've reworded to make clear that 0 and 1 are just examples
There was a problem hiding this comment.
That rewording was for only 1 of 4 docstrings. I now edited all of them, and for one adopted the more extensive description from the array API standard.
There was a problem hiding this comment.
@MarcoGorelli if you're happy with that change, I think this PR is good to go.
rgommers
changed the title
correction to stdcorrection keyword to the std methods
|
Also a note on the default: that is |
|
much appreciated, nice improvement - thanks! |
closes #170