Skip to content

Commit 8044135

Browse files
authored
Specity the types of numpydoc_xref_ignore option (#631)
Added `types` parameter to accept the value `"all"` for the `numpydoc_xref_ignore` option. Fixes gh-630
1 parent 865b865 commit 8044135

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

numpydoc/numpydoc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ def setup(app, get_doc_object_=get_doc_object):
296296
app.add_config_value("numpydoc_attributes_as_param_list", True, True)
297297
app.add_config_value("numpydoc_xref_param_type", False, True)
298298
app.add_config_value("numpydoc_xref_aliases", dict(), True)
299-
app.add_config_value("numpydoc_xref_ignore", set(), True)
299+
app.add_config_value("numpydoc_xref_ignore", set(), True, types=[set, str])
300300
app.add_config_value("numpydoc_validation_checks", set(), True)
301301
app.add_config_value("numpydoc_validation_exclude", set(), False)
302302
app.add_config_value("numpydoc_validation_overrides", dict(), False)

0 commit comments

Comments
 (0)