ignore error from undocumented Python class

oliver-sanders · oliver-sanders · commit d84e3b7266e3 · 2023-03-07T16:54:34.000Z
diff --git a/src/conf.py b/src/conf.py
@@ -122,6 +122,12 @@
     )
 }
 
+nitpick_ignore = [
+    # This class appears in documented type-hints but is not documented in the
+    # Python docs so fails build.
+    ('py:class', 're.Pattern')
+]
+
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # exclude_patterns = ['_build']

Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,12 @@`
`122`	`122`	`)`
`123`	`123`	`}`
`124`	`124`
	`125`	`+nitpick_ignore = [`
	`126`	`+ # This class appears in documented type-hints but is not documented in the`
	`127`	`+ # Python docs so fails build.`
	`128`	`+ ('py:class', 're.Pattern')`
	`129`	`+]`
	`130`	`+`
`125`	`131`	`# List of patterns, relative to source directory, that match files and`
`126`	`132`	`# directories to ignore when looking for source files.`
`127`	`133`	`# exclude_patterns = ['_build']`