summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@gmail.com>2023-04-22 21:28:37 +0100
committerRalf Gommers <ralf.gommers@gmail.com>2023-04-22 21:28:37 +0100
commit69a33deac0375ba9a3c1f0500d06c65dbba00e34 (patch)
tree0c6bcfd1411366412b144d4b5ed00f528b632b39 /doc/source
parent6d95ea6d978e71d9d07937c1bfda7a496872a626 (diff)
downloadnumpy-69a33deac0375ba9a3c1f0500d06c65dbba00e34.tar.gz
DOC: fix two broken links and a couple of very minor textual issues
[skip cirrus] [skip azp] [skip actions]
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/reference/random/compatibility.rst6
-rw-r--r--doc/source/reference/random/index.rst10
2 files changed, 8 insertions, 8 deletions
diff --git a/doc/source/reference/random/compatibility.rst b/doc/source/reference/random/compatibility.rst
index 09a1c0f1b..138f03ca3 100644
--- a/doc/source/reference/random/compatibility.rst
+++ b/doc/source/reference/random/compatibility.rst
@@ -69,12 +69,12 @@ bit for a small performance improvement.
In general, `BitGenerator` classes have stronger guarantees of
version-to-version stream compatibility. This allows them to be a firmer
building block for downstream users that need it. Their limited API surface
-makes them easier to maintain this compatibility from version to version. See
+makes it easier for them to maintain this compatibility from version to version. See
the docstrings of each `BitGenerator` class for their individual compatibility
guarantees.
-The legacy `RandomState` and the `associated convenience functions
-<random-functions-in-numpy-random>`_ have a stricter version-to-version
+The legacy `RandomState` and the :ref:`associated convenience functions
+<functions-in-numpy-random>` have a stricter version-to-version
compatibility guarantee. For reasons outlined in :ref:`NEP 19 <NEP19>`, we had made
stronger promises about their version-to-version stability early in NumPy's
development. There are still some limited use cases for this kind of
diff --git a/doc/source/reference/random/index.rst b/doc/source/reference/random/index.rst
index 486ebc000..38555b133 100644
--- a/doc/source/reference/random/index.rst
+++ b/doc/source/reference/random/index.rst
@@ -54,14 +54,14 @@ pseudo-randomness was good for in the first place.
The pseudo-random number generators implemented in this module are designed
for statistical modeling and simulation. They are not suitable for security
or cryptographic purposes. See the :py:mod:`secrets` module from the
- standard library such use cases.
+ standard library for such use cases.
Seeds should be large positive integers. `default_rng` can take positive
integers of any size. We recommend using very large, unique numbers to ensure
that your seed is different from anyone else's. This is good practice to ensure
-that your results are statistically independent from theirs unless if you are
+that your results are statistically independent from theirs unless you are
intentionally *trying* to reproduce their result. A convenient way to get
-such seed number is to use :py:func:`secrets.randbits` to get an
+such a seed number is to use :py:func:`secrets.randbits` to get an
arbitrary 128-bit integer.
::
@@ -107,7 +107,7 @@ duplication.
NumPy implements several different `BitGenerator` classes implementing
different RNG algorithms. `default_rng` currently uses `~PCG64` as the
default `BitGenerator`. It has better statistical properties and performance
-over the `~MT19937` algorithm used in the legacy `RandomState`. See
+than the `~MT19937` algorithm used in the legacy `RandomState`. See
:ref:`random-bit-generators` for more details on the supported BitGenerators.
`default_rng` and BitGenerators delegate the conversion of seeds into RNG
@@ -117,7 +117,7 @@ implementation details of each `BitGenerator` algorithm, each of which can
require different amounts of bits for its state. Importantly, it lets you use
arbitrary-sized integers and arbitrary sequences of such integers to mix
together into the RNG state. This is a useful primitive for constructing
-a `flexible pattern for parallel RNG streams <seedsequence-spawn>`_.
+a :ref:`flexible pattern for parallel RNG streams <seedsequence-spawn>`.
For backward compatibility, we still maintain the legacy `RandomState` class.
It continues to use the `~MT19937` algorithm by default, and old seeds continue