DOC: Wrong return type of np.random.choice and wrong variable name in parameter description. #8962
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eric-wieser
reviewed
Apr 20, 2017
numpy/random/mtrand/mtrand.pyx
Outdated
| @@ -1040,7 +1040,7 @@ cdef class RandomState: | |||
|
|
|||
| Returns | |||
| -------- | |||
| samples : 1-D ndarray, shape (size,) | |||
| samples : int or ndarray | |||
There was a problem hiding this comment.
int isn't really correct here - it's either an arbitrary scalar (size == None), or an ndarray
numpy/random/mtrand/mtrand.pyx
Outdated
| @@ -1026,7 +1026,7 @@ cdef class RandomState: | |||
| ----------- | |||
| a : 1-D array-like or int | |||
| If an ndarray, a random sample is generated from its elements. | |||
| If an int, the random sample is generated as if a was np.arange(n) | |||
| If an int, the random sample is generated as if a was np.arange(a) | |||
There was a problem hiding this comment.
"As if a were np.arange(a)". Backticks might be nice here too
There was a problem hiding this comment.
I omitted adding backticks because most of random documentation does not include them. And it's kind of nicer to read without code-formatting.
There was a problem hiding this comment.
I'd argue that at least np.arange should be backticked, but I don't care too much
in parameter description. [ci skip]
eric-wieser
approved these changes
Apr 20, 2017
|
Is there something that needs changing or is it just waiting for another review? |
|
Thanks Michael! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes some minor documentation issues in
np.random.choice:aand notnas indicated by thenp.arange(n)comparison.