8000 DOC: delete incorrect comment about random.random_integers by nohtanoj · Pull Request #12232 · numpy/numpy · GitHub
[go: up one dir, main page]

Skip to content

DOC: delete incorrect comment about random.random_integers #12232

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

Closed
wants to merge 1 commit into from
Closed

DOC: delete incorrect comment about random.random_integers #12232

wants to merge 1 commit into from

Conversation

nohtanoj
Copy link

I do not think the following sentence for the documentation in randint is true: "In particular, this other one is the one to use to generate uniformly distributed discrete non-integers", since random_integers generates integers. It seems like a good idea to delete that sentence entirely.

Copy link
Contributor
@tylerjereddy tylerjereddy left a comment

Choose a reason for hiding this comment

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

The random_integers docs do contain a Note explaining usage for evenly space floating-point number sampling. That may be the basis for the comment.

random_integers has also been deprecated for a while now -- since 1.11.0, though I think we mostly have a freeze on modifying the random interfaces because of their heavy use in testing streams.

So, not sure if this the right focus for a doc fix-up at the moment, though I agree it can be confusing if you don't see the note in that deprecated function.

@mattip
Copy link
Member
mattip commented May 29, 2019

The new np.random.Generator().integers clarifies this by accepting an endpoint kwarg. With that, I think it might be appropriate to remove the sentence from the documentation of the legacy, deprecated function since it probably will not be removed for quite a while yet.

This needs a rebase to fix a conflict.

bashtage added a commit to bashtage/numpy that referenced this pull request Jun 1, 2019
Remove misleading statement about discrete non-integers

closes numpy#12232
@mattip
Copy link
Member
mattip commented Jun 1, 2019

Closing in favor of #13687

@mattip mattip closed this Jun 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0