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

Documentation fix for random.gauss #24935

Merged
merged 2 commits into from Apr 20, 2021

Conversation

jpaalasm
Copy link
Contributor

@jpaalasm jpaalasm commented Mar 19, 2021

Keep the documentation of random.gauss and random.normalvariate in line, because they represent the same thing. The current state of calling the one "Gaussian distribution" and the other "Normal distribution" can cause confusion. They are both the same distribution.

Keep the documentation of random.gauss and random.normalvariate in line, because they represent the same thing. The current state of calling the one "Gaussian distribution" and the other "Normal distribution" can cause confusion. They are both the same distribution.
@jpaalasm jpaalasm requested a review from rhettinger as a code owner Mar 19, 2021
@the-knights-who-say-ni
Copy link

the-knights-who-say-ni commented Mar 19, 2021

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@jpaalasm

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@@ -326,7 +326,7 @@ be found in any statistics text.

.. function:: gauss(mu, sigma)

Gaussian distribution. *mu* is the mean, and *sigma* is the standard
Normal distribution. *mu* is the mean, and *sigma* is the standard
Copy link
Contributor

@rhettinger rhettinger Mar 20, 2021

Choose a reason for hiding this comment

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

Perhaps add something like, "Normal distribution, also called the Gaussian distribution."

Since the function is called "gauss", the docs should at least reference the name.

Copy link
Contributor Author

@jpaalasm jpaalasm Mar 20, 2021

Choose a reason for hiding this comment

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

Would you suggest having that also in random.normalvariate or only in random.gauss?

@github-actions
Copy link

github-actions bot commented Apr 20, 2021

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Apr 20, 2021
@jpaalasm
Copy link
Contributor Author

jpaalasm commented Apr 20, 2021

All right, I did some clicking with the CLA signed thing. Is it good to go now?

@jpaalasm jpaalasm requested a review from rhettinger Apr 20, 2021
@rhettinger rhettinger merged commit 389212c into python:master Apr 20, 2021
12 checks passed
kreathon pushed a commit to kreathon/cpython that referenced this pull request May 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news stale Stale PR or inactive for long period of time.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants