New submission from Charles Newey <char...@newey.me>:

The Python 3 documentation for the "random" module mentions two possible ways 
to generate a random variate drawn from a normal distribution - "random.gauss" 
and "random.normalvariate" (see: 
https://docs.python.org/3/library/random.html#random.gauss).

It's not clear what the distinction is other than apparently the "random.gauss" 
function is faster. Digging through the source code, it eventually becomes 
apparent that "random.gauss" is NOT thread safe... but this isn't mentioned in 
the documentation anywhere.

Further, the documentation doesn't make explicit reference to the particular 
method used for generating these Gaussian variates.

Basically what I'm getting at is that it's difficult to tell which function 
("gauss" or "randomvariate") I should be using. I feel that the documentation 
could be clarified here. I'm happy to do this in a PR at some point if required.

----------
assignee: docs@python
components: Documentation
messages: 358703
nosy: cnewey, docs@python
priority: normal
severity: normal
status: open
title: Documentation for "random.gauss" vs "random.normalvariate" is lacking
type: enhancement
versions: Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9

_______________________________________
Python tracker <rep...@bugs.python.org>
<https://bugs.python.org/issue39108>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to