Skip to content

docs: enable nitpicky mode #671

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
merged 1 commit into from
Sep 3, 2025
Merged

docs: enable nitpicky mode #671

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
4 changes: 4 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@
# Don't include object entries (e.g. functions, classes) in the table of contents.
toc_object_entries = False

# Warn about all references where the target cannot be found.
nitpicky = True


class MyTranslator(HTML5Translator):
"""Adds a link target to name without `typing_extensions.` prefix."""
def visit_desc_signature(self, node: Element) -> None:
Expand Down
12 changes: 6 additions & 6 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ Special typing primitives
``default=None`` is passed, and to :data:`NoDefault` if no value is passed.

Previously, passing ``None`` would result in :attr:`!__default__` being set
to :py:class:`types.NoneType`, and passing no value for the parameter would
to :py:data:`types.NoneType`, and passing no value for the parameter would
result in :attr:`!__default__` being set to ``None``.

.. versionchanged:: 4.12.0
Expand Down Expand Up @@ -470,7 +470,7 @@ Special typing primitives

``TypedDict`` is now a function rather than a class.
This brings ``typing_extensions.TypedDict`` closer to the implementation
of :py:mod:`typing.TypedDict` on Python 3.9 and higher.
of :py:class:`typing.TypedDict` on Python 3.9 and higher.

.. versionchanged:: 4.7.0

Expand Down Expand Up @@ -525,7 +525,7 @@ Special typing primitives
``default=None`` is passed, and to :data:`NoDefault` if no value is passed.

Previously, passing ``None`` would result in :attr:`!__default__` being set
to :py:class:`types.NoneType`, and passing no value for the parameter would
to :py:data:`types.NoneType`, and passing no value for the parameter would
result in :attr:`!__default__` being set to ``None``.

.. versionchanged:: 4.12.0
Expand Down Expand Up @@ -556,7 +556,7 @@ Special typing primitives
``default=None`` is passed, and to :data:`NoDefault` if no value is passed.

Previously, passing ``None`` would result in :attr:`!__default__` being set
to :py:class:`types.NoneType`, and passing no value for the parameter would
to :py:data:`types.NoneType`, and passing no value for the parameter would
result in :attr:`!__default__` being set to ``None``.

.. versionchanged:: 4.12.0
Expand Down Expand Up @@ -798,7 +798,7 @@ Functions
* Raises :exc:`TypeError` when it encounters certain objects that are
not valid type hints.
* Replaces type hints that evaluate to :const:`!None` with
:class:`types.NoneType`.
:data:`types.NoneType`.
* Supports the :attr:`Format.FORWARDREF` and
:attr:`Format.STRING` formats.

Expand Down Expand Up @@ -1368,7 +1368,7 @@ versions of Python, but all are listed here for completeness.

.. data:: Union

See :py:data:`typing.Union`.
See :py:class:`typing.Union`.

.. versionadded:: 4.7.0

Expand Down
Loading