summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormattip <matti.picus@gmail.com>2019-12-03 07:43:16 +0200
committermattip <matti.picus@gmail.com>2019-12-03 07:43:16 +0200
commitb2f2700469dbda3c791fb6a3a1dad1f95c4f7a8a (patch)
tree14f903044208ccace954022aec6f0810276e1557
parent2b791a5906a2243b4e0a3318bd460b2062416fb9 (diff)
downloadnumpy-b2f2700469dbda3c791fb6a3a1dad1f95c4f7a8a.tar.gz
DOC: fixes from review
-rw-r--r--doc/source/reference/random/c-api.rst16
-rw-r--r--doc/source/reference/random/examples/cffi.rst2
-rw-r--r--doc/source/reference/random/examples/numba.rst2
-rw-r--r--doc/source/reference/random/examples/numba_cffi.rst2
4 files changed, 7 insertions, 15 deletions
diff --git a/doc/source/reference/random/c-api.rst b/doc/source/reference/random/c-api.rst
index bdb6ead04..2a9de04dc 100644
--- a/doc/source/reference/random/c-api.rst
+++ b/doc/source/reference/random/c-api.rst
@@ -45,7 +45,7 @@ like CFFI. All the functions accept a :c:type:`bitgen_t` as their first argument
See :doc:`extending` for examples of using these functions.
-The functions are named with the following cconventions:
+The functions are named with the following conventions:
- "standard" refers to the reference values for any parameters. For instance
"standard_uniform" means a uniform distribution on the interval ``0.0`` to
@@ -98,13 +98,14 @@ The functions are named with the following cconventions:
.. c:function:: double random_exponential(bitgen_t *bitgen_state, double scale)
.. c:function:: double random_uniform(bitgen_t *bitgen_state, double lower, double range)
+
.. c:function:: double random_beta(bitgen_t *bitgen_state, double a, double b)
.. c:function:: double random_chisquare(bitgen_t *bitgen_state, double df)
.. c:function:: double random_f(bitgen_t *bitgen_state, double dfnum, double dfden)
-.. c:function:: double random_cauchy(bitgen_t *bitgen_state)
+.. c:function:: double random_standard_cauchy(bitgen_t *bitgen_state)
.. c:function:: double random_pareto(bitgen_t *bitgen_state, double a)
@@ -122,18 +123,15 @@ The functions are named with the following cconventions:
.. c:function:: double random_rayleigh(bitgen_t *bitgen_state, double mode)
-.. c:function:: double random_student_t(bitgen_t *bitgen_state, double df)
+.. c:function:: double random_standard_t(bitgen_t *bitgen_state, double df)
-.. c:function:: double random_noncentral_chisquare(bitgen_t *bitgen_state, double df,
- double nonc)
-.. c:function:: double random_noncentral_f(bitgen_t *bitgen_state, double dfnum,
- double dfden, double nonc)
+.. c:function:: double random_noncentral_chisquare(bitgen_t *bitgen_state, double df, double nonc)
+.. c:function:: double random_noncentral_f(bitgen_t *bitgen_state, double dfnum, double dfden, double nonc)
.. c:function:: double random_wald(bitgen_t *bitgen_state, double mean, double scale)
.. c:function:: double random_vonmises(bitgen_t *bitgen_state, double mu, double kappa)
-.. c:function:: double random_triangular(bitgen_t *bitgen_state, double left, double mode,
- double right)
+.. c:function:: double random_triangular(bitgen_t *bitgen_state, double left, double mode, double right)
.. c:function:: npy_int64 random_poisson(bitgen_t *bitgen_state, double lam)
diff --git a/doc/source/reference/random/examples/cffi.rst b/doc/source/reference/random/examples/cffi.rst
index 79cdf6a8f..04d52203b 100644
--- a/doc/source/reference/random/examples/cffi.rst
+++ b/doc/source/reference/random/examples/cffi.rst
@@ -1,7 +1,5 @@
Extending via CFFI
------------------
-The source of ``numpy/random/_examples/cffi/extending.py``
-
.. literalinclude:: ../../../../../numpy/random/_examples/cffi/extending.py
:language: python
diff --git a/doc/source/reference/random/examples/numba.rst b/doc/source/reference/random/examples/numba.rst
index 1a6dd6e85..b41a02568 100644
--- a/doc/source/reference/random/examples/numba.rst
+++ b/doc/source/reference/random/examples/numba.rst
@@ -1,7 +1,5 @@
Extending via Numba
-------------------
-The source of ``numpy/random/_examples/numba/extending.py``
-
.. literalinclude:: ../../../../../numpy/random/_examples/numba/extending.py
:language: python
diff --git a/doc/source/reference/random/examples/numba_cffi.rst b/doc/source/reference/random/examples/numba_cffi.rst
index c3e38537f..fb2f85cce 100644
--- a/doc/source/reference/random/examples/numba_cffi.rst
+++ b/doc/source/reference/random/examples/numba_cffi.rst
@@ -1,7 +1,5 @@
Extending via Numba and CFFI
----------------------------
-The source of ``numpy/random/_examples/numba/extending_distributions.py``
-
.. literalinclude:: ../../../../../numpy/random/_examples/numba/extending_distributions.py
:language: python