Skip to content

gh-101100: Fix Sphinx warnings in library/random.rst #112981

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.

Sign up for GitHub

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

Merged
hugovk merged 12 commits into from
Dec 28, 2023
Merged

gh-101100: Fix Sphinx warnings in library/random.rst #112981

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
27cc059
Fix Sphinx warnings in library/random.rst
hugovk Dec 11, 2023
d3d310f
Update links
hugovk Dec 11, 2023
bceba6e
NoneType -> None
hugovk Dec 12, 2023
4bbac89
Fix references to undocumented class methods
hugovk Dec 12, 2023
01af3f1
Fix references to undocumented class methods
hugovk Dec 13, 2023
08d4625
Merge remote-tracking branch 'upstream/main' into docs-fix-sphinx-war…
hugovk Dec 25, 2023
9093f5c
Add stub entries for Random methods
hugovk Dec 25, 2023
038f715
Move comments inwards to fit without horizontal scrolling
hugovk Dec 25, 2023
bc536ba
Move info about subclassing to one place; update signatures
hugovk Dec 28, 2023
534f6b8
Squigglify for readability
hugovk Dec 28, 2023
62d7344
suppress links to the class we're already in
AlexWaygood Dec 28, 2023
2ba1663
Update Random.getrandbits
hugovk Dec 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add stub entries for Random methods
  • Loading branch information
@hugovk
hugovk committed Dec 25, 2023
commit 9093f5c3540c0e6095182dab9ba3fa48e71405fa
33 changes: 29 additions & 4 deletions Doc/library/random.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ instance of the :class:`random.Random` class. You can instantiate your own
instances of :class:`Random` to get generators that don't share state.

Class :class:`Random` can also be subclassed if you want to use a different
basic generator of your own devising: in that case, override the :meth:`!random`,
:meth:`!seed`, :meth:`!getstate`, and :meth:`!setstate` methods.
Optionally, a new generator can supply a :meth:`!getrandbits` method --- this
basic generator of your own devising: in that case, override the :meth:`~Random.random`,
:meth:`~Random.seed`, :meth:`~Random.getstate`, and :meth:`~Random.setstate` methods.
Optionally, a new generator can supply a :meth:`~Random.getrandbits` method --- this
allows :meth:`randrange` to produce selections over an arbitrarily large range.

The :mod:`random` module also provides the :class:`SystemRandom` class which
Expand Down Expand Up @@ -412,6 +412,31 @@ Alternative Generator
``None``, :class:`int`, :class:`float`, :class:`str`,
:class:`bytes`, or :class:`bytearray`.

.. method:: Random.seed()
Comment thread
AlexWaygood marked this conversation as resolved.
Outdated

Override this method in subclasses to customise the :meth:`random.seed`
behaviour of :class:`Random` instances.

.. method:: Random.getstate()

Override this method in subclasses to customise the :meth:`random.getstate`
behaviour of :class:`Random` instances.

.. method:: Random.setstate()
Comment thread
AlexWaygood marked this conversation as resolved.
Outdated

Override this method in subclasses to customise the :meth:`random.setstate`
behaviour of :class:`Random` instances.

.. method:: Random.getrandbits()
Comment thread
AlexWaygood marked this conversation as resolved.
Outdated

Override this method in subclasses to customise the :meth:`random.getrandbits`
behaviour of :class:`Random` instances.

.. method:: Random.random()

Override this method in subclasses to customise the :meth:`random.random`
behaviour of :class:`Random` instances.

.. class:: SystemRandom([seed])

Class that uses the :func:`os.urandom` function for generating random numbers
Expand All @@ -435,7 +460,7 @@ change across Python versions, but two aspects are guaranteed not to change:
* If a new seeding method is added, then a backward compatible seeder will be
offered.

* The generator's :meth:`!random` method will continue to produce the same
* The generator's :meth:`~Random.random` method will continue to produce the same
sequence when the compatible seeder is given the same seed.

.. _random-examples:
Expand Down