The deprecated-removed Sphinx extension need to change the error message based on the Python version

[remilapeyre]

BPO	40798
Nosy	@JulienPalard, @miss-islington, @DahlitzFlorian, @remilapeyre
PRs	bpo-40798: Generate a different message for already removed elements #20483 [3.9] bpo-40798: Generate a different message for already removed elements (GH-20483) #20531 [3.8] bpo-40798: Generate a different message for already removed elements (GH-20483) #20532 [3.7] bpo-40798: Generate a different message for already removed elements (GH-20483) #20533

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2020-05-30.07:49:32.596>
created_at = <Date 2020-05-27.21:56:58.275>
labels = ['type-bug', '3.8', '3.9', '3.10', 'docs']
title = 'The deprecated-removed Sphinx extension need to change the error message based on the Python version'
updated_at = <Date 2020-05-30.07:55:02.246>
user = 'https://github.com/remilapeyre'

bugs.python.org fields:

activity = <Date 2020-05-30.07:55:02.246>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-05-30.07:49:32.596>
closer = 'mdk'
components = ['Documentation']
creation = <Date 2020-05-27.21:56:58.275>
creator = 'remi.lapeyre'
dependencies = []
files = []
hgrepos = []
issue_num = 40798
keywords = ['patch']
message_count = 8.0
messages = ['370141', '370199', '370200', '370360', '370361', '370362', '370363', '370364']
nosy_count = 5.0
nosy_names = ['docs@python', 'mdk', 'miss-islington', 'DahlitzFlorian', 'remi.lapeyre']
pr_nums = ['20483', '20531', '20532', '20533']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue40798'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

[remilapeyre]

The new deprecated-removed extension in the documentation always produces text like this:

Deprecated since version 3.4, will be removed in version 3.8: MD5 as implicit default digest

This message should be used in the documentation of 3.4 to 3.7 and then it should produce:

Deprecated since version 3.4, removed in version 3.8: MD5 as implicit default digest

I'm not sure if Sphinx knows which Python version it is building the documentation for.

This is the only instance were this is used with a version less than 3.9 so all other messages are currently correct.

I think a new contributor should be able to fix this.

[DahlitzFlorian]

I would like to submit a PR for it if possible.

[remilapeyre]

Hi Florian, please have a go and open one on GitHub so it can be reviewed.

[JulienPalard]

New changeset 735d902 by Florian Dahlitz in branch 'master':
bpo-40798: Generate a different message for already removed elements (GH-20483)
735d902

[JulienPalard]

Thanks @rémi for this great idea and Florian for the implementation!

[miss-islington]

New changeset a9dbae4 by Miss Islington (bot) in branch '3.7':
bpo-40798: Generate a different message for already removed elements (GH-20483)
a9dbae4

[miss-islington]

New changeset 588efc2 by Miss Islington (bot) in branch '3.9':
bpo-40798: Generate a different message for already removed elements (GH-20483)
588efc2

[miss-islington]

New changeset ba1c2c8 by Miss Islington (bot) in branch '3.8':
bpo-40798: Generate a different message for already removed elements (GH-20483)
ba1c2c8