IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Revert the default type of `nitpick_ignore[_regex] to list`

Browse Source
This commit is contained in:
Adam Turner 2023-04-25 11:31:57 +01:00
parent 60d8fa10b8
commit d2aa91f63c
3 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -16,6 +16,9 @@ Features added
Bugs fixed
----------
* #11355: Revert the default type of :confval:`nitpick_ignore` and
:confval:`nitpick_ignore_regex` to ``list``.
Testing
--------

4
sphinx/config.py
View File

@ -132,8 +132,8 @@ class Config:
'needs_extensions': ({}, None, []),
'manpages_url': (None, 'env', []),
'nitpicky': (False, None, []),
'nitpick_ignore': (set(), None, [set, list, tuple]),
'nitpick_ignore_regex': (set(), None, [set, list, tuple]),
'nitpick_ignore': ([], None, [set, list, tuple]),
'nitpick_ignore_regex': ([], None, [set, list, tuple]),
'numfig': (False, 'env', []),
'numfig_secnum_depth': (1, 'env', []),
'numfig_format': ({}, 'env', []), # will be initialized in init_numfig_format()

15
tests/test_config.py
View File

@ -427,3 +427,18 @@ def test_conf_py_no_language(tempdir):
# Then the language is coerced to English
assert cfg.language == "en"
def test_conf_py_nitpick_ignore_list(tempdir):
"""Regression test for #11355."""
# Given a conf.py file with no language attribute
(tempdir / 'conf.py').write_text("", encoding='utf-8')
# When we load conf.py into a Config object
cfg = Config.read(tempdir, {}, None)
cfg.init_values()
# Then the default nitpick_ignore[_regex] is an empty list
assert cfg.nitpick_ignore == []
assert cfg.nitpick_ignore_regex == []