Skip to content

Commit 0cc338f

Browse files
authored
Merge pull request #10119 from Bibo-Joshi/elaborate-docs-on-nitpick_ignore
Documentation: Mention `nitpick_ignore(_regex)` in docs of `warn-missing-reference`
2 parents 2be0630 + 84a6270 commit 0cc338f

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/extdev/appapi.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,9 @@ Here is a more detailed list of these events.
298298

299299
Emitted when a cross-reference to an object cannot be resolved even after
300300
:event:`missing-reference`. If the event handler can emit warnings for
301-
the missing reference, it should return ``True``.
301+
the missing reference, it should return ``True``. The configuration variables
302+
:confval:`nitpick_ignore` and :confval:`nitpick_ignore_regex` prevent the
303+
event from being emitted for the corresponding nodes.
302304

303305
.. versionadded:: 3.4
304306

0 commit comments

Comments
 (0)