Skip to content

Commit

Permalink
Edits to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ngnpope committed Jan 3, 2025
1 parent 50c6294 commit 9437f4e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
10 changes: 6 additions & 4 deletions Doc/library/uuid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -288,23 +288,24 @@ of the :attr:`~UUID.variant` attribute:

Reserved for future definition.


The :mod:`uuid` module defines the special Nil and Max UUID values:


.. data:: NIL
.. const:: NIL

A special form of UUID that is specified to have all 128 bits set to zero
according to :rfc:`RFC 9562, §5.9 <9562#section-5.9>`.

.. versionadded:: 3.14
.. versionadded:: next


.. data:: MAX
.. const:: MAX

A special form of UUID that is specified to have all 128 bits set to one
according to :rfc:`RFC 9562, §5.10 <9562#section-5.10>`.

.. versionadded:: 3.14
.. versionadded:: next


.. seealso::
Expand Down Expand Up @@ -406,6 +407,7 @@ Here are some examples of typical usage of the :mod:`uuid` module::
>>> uuid.MAX
UUID('ffffffff-ffff-ffff-ffff-ffffffffffff')


.. _uuid-cli-example:

Command-Line Example
Expand Down
7 changes: 4 additions & 3 deletions Doc/whatsnew/3.14.rst
Original file line number Diff line number Diff line change
Expand Up @@ -665,9 +665,10 @@ uuid
in :rfc:`9562`.
(Contributed by Bénédikt Tran in :gh:`89083`.)

* :data:`uuid.NIL` and :data:`uuid.MAX` are now available to represent the Nil
and Max UUID formats as defined by :rfc:`9562`. (Contributed by Nick Pope in
:gh:`128427`.)
* :const:`uuid.NIL` and :const:`uuid.MAX` are now available to represent the

Check warning on line 668 in Doc/whatsnew/3.14.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

py:const reference target not found: uuid.NIL [ref.const]

Check warning on line 668 in Doc/whatsnew/3.14.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

py:const reference target not found: uuid.MAX [ref.const]
Nil and Max UUID formats as defined by :rfc:`9562`.
(Contributed by Nick Pope in :gh:`128427`.)


zipinfo
-------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
:data:`uuid.NIL` and :data:`uuid.MAX` are now available to represent the Nil
:const:`uuid.NIL` and :const:`uuid.MAX` are now available to represent the Nil
and Max UUID formats as defined by :rfc:`9562`.

0 comments on commit 9437f4e

Please sign in to comment.