Skip to content

gh-89554: Document NoneType, NotImplementedType and EllipsisType as classes #150682

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

Open
gaborbernat wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −8
Open

gh-89554: Document NoneType, NotImplementedType and EllipsisType as classes #150682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions Doc/library/constants.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ A small number of constants live in the built-in namespace. They are:
An object frequently used to represent the absence of a value, as when
default arguments are not passed to a function. Assignments to ``None``
are illegal and raise a :exc:`SyntaxError`.
``None`` is the sole instance of the :data:`~types.NoneType` type.
``None`` is the sole instance of the :class:`~types.NoneType` type.


.. data:: NotImplemented
Expand All @@ -33,7 +33,7 @@ A small number of constants live in the built-in namespace. They are:
the other type; may be returned by the in-place binary special methods
(e.g. :meth:`~object.__imul__`, :meth:`~object.__iand__`, etc.) for the same purpose.
It should not be evaluated in a boolean context.
:data:`!NotImplemented` is the sole instance of the :data:`types.NotImplementedType` type.
:data:`!NotImplemented` is the sole instance of the :class:`types.NotImplementedType` type.

.. note::

Expand Down Expand Up @@ -68,7 +68,7 @@ A small number of constants live in the built-in namespace. They are:
The same as the ellipsis literal "``...``", an object frequently used to
indicate that something is omitted. Assignment to ``Ellipsis`` is possible, but
assignment to ``...`` raises a :exc:`SyntaxError`.
``Ellipsis`` is the sole instance of the :data:`types.EllipsisType` type.
``Ellipsis`` is the sole instance of the :class:`types.EllipsisType` type.


.. data:: __debug__
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ If you instantiate any of these types, note that signatures may vary between Pyt

Standard names are defined for the following types:

.. data:: NoneType
.. class:: NoneType

The type of :data:`None`.

Expand Down Expand Up @@ -233,7 +233,7 @@ Standard names are defined for the following types:
.. versionadded:: 3.7


.. data:: NotImplementedType
.. class:: NotImplementedType

The type of :data:`NotImplemented`.

Expand Down Expand Up @@ -273,7 +273,7 @@ Standard names are defined for the following types:
creating :class:`!ModuleType` instances which ensures the various
attributes are set appropriately.

.. data:: EllipsisType
.. class:: EllipsisType

The type of :data:`Ellipsis`.

Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/3.10.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1446,8 +1446,8 @@ as a positional-only argument.
types
-----

Reintroduce the :data:`types.EllipsisType`, :data:`types.NoneType`
and :data:`types.NotImplementedType` classes, providing a new set
Reintroduce the :class:`types.EllipsisType`, :class:`types.NoneType`
and :class:`types.NotImplementedType` classes, providing a new set
of types readily interpretable by type checkers.
(Contributed by Bas van Beek in :issue:`41810`.)

Expand Down
Loading