Skip to content

Commit d5feeb1

Browse files
docs: enable nitpicky mode (python#671)
1 parent 66146e7 commit d5feeb1

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

doc/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@
5656
# Don't include object entries (e.g. functions, classes) in the table of contents.
5757
toc_object_entries = False
5858

59+
# Warn about all references where the target cannot be found.
60+
nitpicky = True
61+
62+
5963
class MyTranslator(HTML5Translator):
6064
"""Adds a link target to name without `typing_extensions.` prefix."""
6165
def visit_desc_signature(self, node: Element) -> None:

doc/index.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ Special typing primitives
303303
``default=None`` is passed, and to :data:`NoDefault` if no value is passed.
304304

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

309309
.. versionchanged:: 4.12.0
@@ -470,7 +470,7 @@ Special typing primitives
470470

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

475475
.. versionchanged:: 4.7.0
476476

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

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

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

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

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

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

13691369
.. data:: Union
13701370

1371-
See :py:data:`typing.Union`.
1371+
See :py:class:`typing.Union`.
13721372

13731373
.. versionadded:: 4.7.0
13741374

0 commit comments

Comments
 (0)