Skip to content

Commit 20b419d

Browse files
committed
docs: enable nitpicky mode
Catch broken references.
1 parent 80a73dc commit 20b419d

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/conf.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,19 @@
6161

6262
autodoc_member_order = "bysource"
6363

64+
nitpicky = True
65+
nitpick_ignore = {
66+
# Don't want to expose this yet (see #428).
67+
("py:class", "pluggy._tracing.TagTracerSub"),
68+
# Compat hack, don't want to expose it.
69+
("py:class", "pluggy._manager.DistFacade"),
70+
# `types.ModuleType` turns into `module` but then fails to resolve...
71+
("py:class", "module"),
72+
# Just a TypeVar.
73+
("py:obj", "pluggy._result.ResultType"),
74+
("py:class", "pluggy._result.ResultType"),
75+
}
76+
6477
# -- Options for Texinfo output -------------------------------------------
6578

6679
# Grouping the document tree into Texinfo files. List of tuples

src/pluggy/_manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ def parse_hookimpl_opts(self, plugin: _Plugin, name: str) -> HookimplOpts | None
174174
175175
This method can be overridden by ``PluginManager`` subclasses to
176176
customize how hook implementation are picked up. By default, returns the
177-
options for items decorated with :class:`HookImplMarker`.
177+
options for items decorated with :class:`HookimplMarker`.
178178
"""
179179
method: object = getattr(plugin, name)
180180
if not inspect.isroutine(method):

0 commit comments

Comments
 (0)