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

Simplify the type of configuration value descriptions (#12553)

Browse Source 
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.
This commit is contained in:
Adam Turner 2024-07-13 07:35:39 +01:00 committed by GitHub
parent 3b19a7b4ba
commit 063c97304d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sphinx/application.py
View File

@ -530,7 +530,7 @@ class Sphinx:
def add_config_value( def add_config_value(
self, name: str, default: Any, rebuild: _ConfigRebuild, self, name: str, default: Any, rebuild: _ConfigRebuild,
types: type | Collection[type] | ENUM = (), types: type | Collection[type] | ENUM = (),
description: str | None = None, description: str = '',
) -> None: ) -> None:
"""Register a configuration value. """Register a configuration value.

11
sphinx/config.py
View File

@ -94,7 +94,6 @@ class ENUM:
_OptValidTypes = Union[tuple[()], tuple[type, ...], frozenset[type], ENUM] _OptValidTypes = Union[tuple[()], tuple[type, ...], frozenset[type], ENUM]
_DescriptionType = Union[str, None]
class _Opt: class _Opt:
@ -103,14 +102,14 @@ class _Opt:
default: Any default: Any
rebuild: _ConfigRebuild rebuild: _ConfigRebuild
valid_types: _OptValidTypes valid_types: _OptValidTypes
description: _DescriptionType description: str
def __init__( def __init__(
self, self,
default: Any, default: Any,
rebuild: _ConfigRebuild, rebuild: _ConfigRebuild,
valid_types: _OptValidTypes, valid_types: _OptValidTypes,
description: _DescriptionType = None, description: str = '',
) -> None: ) -> None:
"""Configuration option type for Sphinx. """Configuration option type for Sphinx.
@ -163,11 +162,11 @@ class _Opt:
raise TypeError(msg) raise TypeError(msg)
super().__delattr__(key) super().__delattr__(key)
def __getstate__(self) -> tuple[Any, _ConfigRebuild, _OptValidTypes, _DescriptionType]: def __getstate__(self) -> tuple[Any, _ConfigRebuild, _OptValidTypes, str]:
return self.default, self.rebuild, self.valid_types, self.description return self.default, self.rebuild, self.valid_types, self.description
def __setstate__( def __setstate__(
self, state: tuple[Any, _ConfigRebuild, _OptValidTypes, _DescriptionType]) -> None: self, state: tuple[Any, _ConfigRebuild, _OptValidTypes, str]) -> None:
default, rebuild, valid_types, description = state default, rebuild, valid_types, description = state
super().__setattr__('default', default) super().__setattr__('default', default)
super().__setattr__('rebuild', rebuild) super().__setattr__('rebuild', rebuild)
@ -453,7 +452,7 @@ class Config:
def add(self, name: str, default: Any, rebuild: _ConfigRebuild, def add(self, name: str, default: Any, rebuild: _ConfigRebuild,
types: type | Collection[type] | ENUM, types: type | Collection[type] | ENUM,
description: str | None = None) -> None: description: str = '') -> None:
if name in self._options: if name in self._options:
raise ExtensionError(__('Config value %r already present') % name) raise ExtensionError(__('Config value %r already present') % name)