Skip to content

Commit fb6db30

Browse files
tk0miyaAA-Turner
authored andcommitted
Update comment
1 parent 68252c6 commit fb6db30

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

sphinx/config.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,10 @@ def read(cls, confdir: str, overrides: Dict = None, tags: Tags = None) -> "Confi
165165
confdir)
166166
namespace = eval_config_file(filename, tags)
167167

168-
# Resolve https://github.com/sphinx-doc/sphinx/issues/10474 where conf.py
169-
# explicitly sets language to None, by coercing it to English.
168+
# Note: Old sphinx projects has been configured as "langugae = None" because
169+
# sphinx-quickstart had generated the configuration by default formerly.
170+
# To keep compatibility, they should be fallback to 'en' for a while
171+
# (At least 2 years or more since v5.0 release).
170172
if namespace.get("language", ...) is None:
171173
logging.warning(__("Invalid configuration found: 'language = None'. "
172174
"Now it takes only a string. Please update your configuration. "

0 commit comments

Comments
 (0)