Skip to content

Commit 063c973

Browse files
authored
Simplify the type of configuration value descriptions (#12553)
There's no real reason to have the empty string as a description, and hence we can just make the type ``str`` rather than a union.
1 parent 3b19a7b commit 063c973

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

sphinx/application.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -530,7 +530,7 @@ def add_builder(self, builder: type[Builder], override: bool = False) -> None:
530530
def add_config_value(
531531
self, name: str, default: Any, rebuild: _ConfigRebuild,
532532
types: type | Collection[type] | ENUM = (),
533-
description: str | None = None,
533+
description: str = '',
534534
) -> None:
535535
"""Register a configuration value.
536536

sphinx/config.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,6 @@ def match(self, value: str | list | tuple) -> bool:
9494

9595

9696
_OptValidTypes = Union[tuple[()], tuple[type, ...], frozenset[type], ENUM]
97-
_DescriptionType = Union[str, None]
9897

9998

10099
class _Opt:
@@ -103,14 +102,14 @@ class _Opt:
103102
default: Any
104103
rebuild: _ConfigRebuild
105104
valid_types: _OptValidTypes
106-
description: _DescriptionType
105+
description: str
107106

108107
def __init__(
109108
self,
110109
default: Any,
111110
rebuild: _ConfigRebuild,
112111
valid_types: _OptValidTypes,
113-
description: _DescriptionType = None,
112+
description: str = '',
114113
) -> None:
115114
"""Configuration option type for Sphinx.
116115
@@ -163,11 +162,11 @@ def __delattr__(self, key: str) -> None:
163162
raise TypeError(msg)
164163
super().__delattr__(key)
165164

166-
def __getstate__(self) -> tuple[Any, _ConfigRebuild, _OptValidTypes, _DescriptionType]:
165+
def __getstate__(self) -> tuple[Any, _ConfigRebuild, _OptValidTypes, str]:
167166
return self.default, self.rebuild, self.valid_types, self.description
168167

169168
def __setstate__(
170-
self, state: tuple[Any, _ConfigRebuild, _OptValidTypes, _DescriptionType]) -> None:
169+
self, state: tuple[Any, _ConfigRebuild, _OptValidTypes, str]) -> None:
171170
default, rebuild, valid_types, description = state
172171
super().__setattr__('default', default)
173172
super().__setattr__('rebuild', rebuild)
@@ -453,7 +452,7 @@ def __iter__(self) -> Iterator[ConfigValue]:
453452

454453
def add(self, name: str, default: Any, rebuild: _ConfigRebuild,
455454
types: type | Collection[type] | ENUM,
456-
description: str | None = None) -> None:
455+
description: str = '') -> None:
457456
if name in self._options:
458457
raise ExtensionError(__('Config value %r already present') % name)
459458

0 commit comments

Comments
 (0)