Skip to content

Commit d2aa91f

Browse files
committed
Revert the default type of nitpick_ignore[_regex] to list
1 parent 60d8fa1 commit d2aa91f

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed

CHANGES

+3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ Features added
1616
Bugs fixed
1717
----------
1818

19+
* #11355: Revert the default type of :confval:`nitpick_ignore` and
20+
:confval:`nitpick_ignore_regex` to ``list``.
21+
1922
Testing
2023
--------
2124

sphinx/config.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@ class Config:
132132
'needs_extensions': ({}, None, []),
133133
'manpages_url': (None, 'env', []),
134134
'nitpicky': (False, None, []),
135-
'nitpick_ignore': (set(), None, [set, list, tuple]),
136-
'nitpick_ignore_regex': (set(), None, [set, list, tuple]),
135+
'nitpick_ignore': ([], None, [set, list, tuple]),
136+
'nitpick_ignore_regex': ([], None, [set, list, tuple]),
137137
'numfig': (False, 'env', []),
138138
'numfig_secnum_depth': (1, 'env', []),
139139
'numfig_format': ({}, 'env', []), # will be initialized in init_numfig_format()

tests/test_config.py

+15
Original file line numberDiff line numberDiff line change
@@ -427,3 +427,18 @@ def test_conf_py_no_language(tempdir):
427427

428428
# Then the language is coerced to English
429429
assert cfg.language == "en"
430+
431+
432+
def test_conf_py_nitpick_ignore_list(tempdir):
433+
"""Regression test for #11355."""
434+
435+
# Given a conf.py file with no language attribute
436+
(tempdir / 'conf.py').write_text("", encoding='utf-8')
437+
438+
# When we load conf.py into a Config object
439+
cfg = Config.read(tempdir, {}, None)
440+
cfg.init_values()
441+
442+
# Then the default nitpick_ignore[_regex] is an empty list
443+
assert cfg.nitpick_ignore == []
444+
assert cfg.nitpick_ignore_regex == []

0 commit comments

Comments
 (0)