8000 Add versionadded directives to ssl.minimum_version and ssl.maximum_version by zmwangx · Pull Request #11894 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Add versionadded directives to ssl.minimum_version and ssl.maximum_version #11894

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Feb 28, 2019
Merged

Add versionadded directives to ssl.minimum_version and ssl.maximum_version #11894

merged 2 commits into from
Feb 28, 2019

Conversation

zmwangx
Copy link
Contributor
@zmwangx zmwangx commented Feb 16, 2019

ssl.minimum_version and ssl.maximum_version were introduced in Python 3.7, alongside ssl.TLSVersion and such. Not having versionadded directives is somewhat confusing.

This is trivial enough and warrants skip issue and skip news.

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Feb 16, 2019
vstinner
vstinner previously requested changes Feb 25, 2019
View reviewed changes
Copy link
Member
@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

I would prefer to see "versionadded" after the note, not before. See other docs like bz2, decimal, gzip, http.client, etc. for other examples. I prefer to be consistent for the documentation.

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@csabella
Copy link
Contributor

@vstinner, thanks for the review. I had checked that and the ssl page seems to have both, mostly the changes for 3.7 and 3.8 appear before the note and older ones appear after the note. Do you think the others on this ssl.rst should be cleaned up to be consistent?

@vstinner
Copy link
Member

As soon as ssl doc is inconsistent for note before/after version added, @csabella you can merge the PR if you want. This minor inconsistent shouldn't hold this PR.

@vstinner, thanks for the review. I had checked that and the ssl page seems to have both, mostly the changes for 3.7 and 3.8 appear before the note and older ones appear after the note.

Oh sorry, I didn't notice that.

I consider that the note has more value than the "version added", and so should be read first.

Do you think the others on this ssl.rst should be cleaned up to be consistent?

I don't know. Is there a common style for Python documentation somewhere, cc @JulienPalard ?

@vstinner vstinner dismissed their stale review February 25, 2019 23:07

ssl doc is inconsistent

@zmwangx zmwangx force-pushed the ssl-mark-versionadded branch from 6341c42 to 2309294 Compare February 26, 2019 05:11
@zmwangx
Copy link
Contributor Author
zmwangx commented Feb 26, 2019

I fixed the order throughout ssl.rst (versionadded after note).

@zmwangx
Copy link
Contributor Author
zmwangx commented Feb 26, 2019

I have made the requested changes; please review again.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@csabella: please review the changes made to this pull request.

@csabella
Copy link
Contributor

Looking through other doc pages, it does appear that most of them have the versionadded after the note (as you originally pointed out) and since adjusting it here was minimal, I think the PR looks good. Do you agree @vstinner? Thanks!

@vstinner
Copy link
Member

@tiran: Since you likely added many of these "versionadded", would you mind to review the PR? The PR just moves "versionadded" after notes. IMHO notes are more important than versionadded, and so should be read first.

vstinner
vstinner approved these changes Feb 26, 2019
View reviewed changes
Copy link
Member
@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

LGTM, but I would prefer to see @tiran review first.

@tiran: FYI @csabella (new core dev) wants to be the one who merges this PR ;-)

@csabella csabella requested a review from tiran February 27, 2019 11:13
tiran
tiran approved these changes Feb 28, 2019
View reviewed changes
Copy link
Member
@tiran tiran left a comment

Choose a reason for hiding this comment

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

LGTM. thanks!

@csabella csabella merged commit ae2ea33 into python:master Feb 28, 2019
@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

Sorry, @zmwangx and @csabella, I could not cleanly backport this to 3.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker ae2ea33d5da34a777e77d489b700ff45d753934f 3.7

csabella pushed a commit to csabella/cpython that referenced this pull request Feb 28, 2019
@zmwangx @csabella
[3.7] Add versionadded directives to ssl.minimum_version and ssl.maxi…
08725bf 
…mum_version (pythonGH-11894).

(cherry picked from commit ae2ea33)

Co-authored-by: Zhiming Wang <i@zhimingwang.org>
@csabella csabella mentioned this pull request Feb 28, 2019
Merged
@bedevere-bot
Copy link

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

miss-islington pushed a commit that referenced this pull request Feb 28, 2019
@csabella @zmwangx @miss-islington
[3.7] Add versionadded directives to ssl.minimum_version and ssl.maxi… (
7dc322f 
GH-12101)

…mum_version (GH-11894).

(cherry picked from commit ae2ea33)

Co-authored-by: Zhiming Wang <i@zhimingwang.org>
@csabella
Copy link
Contributor

Thank you for the PR, @zmwangx!

@zmwangx zmwangx deleted the ssl-mark-versionadded branch March 1, 2019 04:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vstinner vstinner vstinner approved these changes

@tiran tiran tiran approved these changes

@csabella csabella csabella approved these changes

Assignees

@csabella csabella

Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@zmwangx @bedevere-bot @csabella @vstinner @miss-islington @tiran @the-knights-who-say-ni
0