Skip to content

Commit af3f647

Browse files
committed
DOC: Final doc clean ups
1 parent 9aa33dd commit af3f647

File tree

4 files changed

+16
-5
lines changed

4 files changed

+16
-5
lines changed

doc/source/change-log.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ v2.3.0
1515
This change is backward incompatible. If ``mode`` is essential, you should continue to use legacy
1616
versions.
1717

18+
- Moved to the build system to meson which improves build time.
19+
- Fixed a breaking change that affected the use of :func:`functools.partial` test suite in
20+
Python 3.14.
21+
22+
.. note::
23+
24+
There was no version 2.2.0.
25+
1826
v2.1.0
1927
======
2028
- Fixed a bug in :class:`~randomgen.pcg64.LCG128Mix` that resulted in ``inc``

doc/source/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ generators, 'in addition' to the standard PRNG in NumPy. The included PRNGs are
100100
arbitrary number of steps or generating independent streams. See the
101101
`Random123`_ page for more details about this class of PRNG.
102102
* Other cryptographic-based generators: :class:`~randomgen.aes.AESCounter`,
103-
:class:`~randomgen.speck128.SPECK128`, :class:`~randomgen.chacha.ChaCha`, and
104-
:class:`~randomgen.hc128.HC128`.
103+
:class:`~randomgen.speck128.SPECK128`, :class:`~randomgen.chacha.ChaCha`,
104+
:class:`~randomgen.hc128.HC128`, and :class:`~randomgen.blabla.BlaBla`.
105105
* XoroShiro128+/++ - Improved version of XorShift128+ with better performance
106106
and statistical quality. Like the XorShift generators, it can be jumped
107107
to produce multiple streams in parallel applications. See
@@ -114,6 +114,8 @@ generators, 'in addition' to the standard PRNG in NumPy. The included PRNGs are
114114
:meth:`~randomgen.xorshift1024.Xorshift1024.jumped` for details. More information
115115
about these PRNGs is available at the
116116
`xorshift, xoroshiro and xoshiro authors' page`_.
117+
* Other PRNGs including :class:`~randomgen.romu.Romu`, :class:`~randomgen.tyche.Tyche`,
118+
and :class:`~randomgen.squares.Squares`.
117119

118120
.. _`NumPy's documentation`: https://docs.scipy.org/doc/numpy/reference/routines.random.html
119121
.. _`dSFMT authors' page`: http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/SFMT/

randomgen/blabla.pyx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -351,12 +351,13 @@ cdef class BlaBla(BitGenerator):
351351

352352
def advance(self, delta):
353353
"""
354-
Advance the state by delta steps
354+
Advance the state by delta steps.
355355
356356
Parameters
357357
----------
358358
delta : int
359-
Number of steps to advance the state.
359+
Number of steps to advance the state. Delta can be any integer value,
360+
but is wrapped to be in [0, 2**128) which is the size of the counter.
360361
"""
361362
# Squeeze with wrap into [0, 2**128)
362363
delta = delta % (1 << 128)

randomgen/dsfmt.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ cdef uint64_t dsfmt_raw(void *st) noexcept nogil:
2323

2424
cdef class DSFMT(BitGenerator):
2525
"""
26-
DSFMT(seed=None, *)
26+
DSFMT(seed=None)
2727
2828
Container for the SIMD-based Mersenne Twister pseudo RNG.
2929

0 commit comments

Comments
 (0)