Skip to content

Commit

Permalink
bpo-40798: Generate a different message for already removed elements (G…
Browse files Browse the repository at this point in the history
…H-20483)

(cherry picked from commit 735d902)

Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
  • Loading branch information
miss-islington and DahlitzFlorian committed May 30, 2020
1 parent 78cf711 commit 588efc2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
13 changes: 11 additions & 2 deletions Doc/tools/extensions/pyspecific.py
Expand Up @@ -311,15 +311,24 @@ 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()
node.document = self.state.document
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],
Expand Down
1 change: 1 addition & 0 deletions Doc/tools/templates/dummy.html
Expand Up @@ -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 %}

0 comments on commit 588efc2

Please sign in to comment.