[Python-checkins] bpo-40798: Generate a different message for already removed elements (GH-20483)
Miss Islington (bot)
webhook-mailer at python.org
Sat May 30 03:52:31 EDT 2020
https://github.com/python/cpython/commit/a9dbae434f26b2c419a1cd0a8233143f40fd00db
commit: a9dbae434f26b2c419a1cd0a8233143f40fd00db
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2020-05-30T00:52:27-07:00
summary:
bpo-40798: Generate a different message for already removed elements (GH-20483)
(cherry picked from commit 735d902b363b759df9ff00e58bbf4f7e2bde78cd)
Co-authored-by: Florian Dahlitz <f2dahlitz at freenet.de>
files:
M Doc/tools/extensions/pyspecific.py
M Doc/tools/templates/dummy.html
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index 466e84c26147c..3b6fa90059160 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -236,7 +236,8 @@ class DeprecatedRemoved(Directive):
final_argument_whitespace = True
option_spec = {}
- _label = 'Deprecated since version {deprecated}, will be removed in version {removed}'
+ _deprecated_label = 'Deprecated since version {deprecated}, will be removed in version {removed}'
+ _removed_label = 'Deprecated since version {deprecated}, removed in version {removed}'
def run(self):
node = addnodes.versionmodified()
@@ -244,7 +245,15 @@ def run(self):
node['type'] = 'deprecated-removed'
version = (self.arguments[0], self.arguments[1])
node['version'] = version
- label = translators['sphinx'].gettext(self._label)
+ env = self.state.document.settings.env
+ current_version = tuple(int(e) for e in env.config.version.split('.'))
+ removed_version = tuple(int(e) for e in self.arguments[1].split('.'))
+ if current_version < removed_version:
+ label = self._deprecated_label
+ else:
+ label = self._removed_label
+
+ label = translators['sphinx'].gettext(label)
text = label.format(deprecated=self.arguments[0], removed=self.arguments[1])
if len(self.arguments) == 3:
inodes, messages = self.state.inline_text(self.arguments[2],
diff --git a/Doc/tools/templates/dummy.html b/Doc/tools/templates/dummy.html
index 8d94137b01b51..68ae3ad148ec2 100644
--- a/Doc/tools/templates/dummy.html
+++ b/Doc/tools/templates/dummy.html
@@ -5,3 +5,4 @@
{% trans %}CPython implementation detail:{% endtrans %}
{% trans %}Deprecated since version {deprecated}, will be removed in version {removed}{% endtrans %}
+{% trans %}Deprecated since version {deprecated}, removed in version {removed}{% endtrans %}
More information about the Python-checkins
mailing list