Skip to content

bpo-36645: Fix ambiguous formatting in re.sub() documentation. #12879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 21, 2019

Conversation

mollison
Copy link
Contributor

@mollison mollison commented Apr 19, 2019

This PR also needs to be backported to 3.7.

https://bugs.python.org/issue36645

@serhiy-storchaka
Copy link
Member

Are there precedences of using versionchanged with the same version multiple times sequentially?

@mollison
Copy link
Contributor Author

@serhiy-storchaka yes. Here are some examples.

versionchanged::3.7 repeated sequentially:
https://docs.python.org/3/library/collections.html#collections.namedtuple

versionchanged::3.2 repeated sequentially:
https://docs.python.org/3/library/urllib.request.html#urllib.request.urlopen

versionchanged::3.7 repeated sequentially:
https://docs.python.org/3/library/dis.html#dis.dis

If you want to look at this issue in greater depth, subprocess.Popen is a more complicated case:
https://docs.python.org/3/library/subprocess.html#subprocess.Popen

Copy link
Member

@berkerpeksag berkerpeksag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that multi-line version{added,changed} markers don't render well:

Screen Shot 2019-04-22 at 1 11 25 AM

This PR makes the note more readable.

LGTM, thank you!

@berkerpeksag berkerpeksag merged commit 5ebfa84 into python:master Apr 21, 2019
@miss-islington
Copy link
Contributor

Thanks @mollison for the PR, and @berkerpeksag for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 21, 2019
@bedevere-bot
Copy link

GH-12898 is a backport of this pull request to the 3.7 branch.

miss-islington added a commit that referenced this pull request Apr 21, 2019
@mollison mollison deleted the fix-issue-36645 branch April 21, 2019 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants