Add versionadded directives to ssl.minimum_version and ssl.maximum_version#11894
Add versionadded directives to ssl.minimum_version and ssl.maximum_version#11894csabella merged 2 commits intopython:masterfrom
Conversation
vstinner
left a comment
vstinner
left a comment
There was a problem hiding this comment.
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.
|
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 |
|
@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 |
|
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.
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.
I don't know. Is there a common style for Python documentation somewhere, cc @JulienPalard ? |
zmwangx
force-pushed
the
ssl-mark-versionadded
branch
from
6341c42 to
2309294
Compare
|
I fixed the order throughout |
|
I have made the requested changes; please review again. |
|
Thanks for making the requested changes! @csabella: please review the changes made to this pull request. |
|
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! |
|
@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. |
|
Sorry, @zmwangx and @csabella, I could not cleanly backport this to |
…mum_version (pythonGH-11894). (cherry picked from commit ae2ea33) Co-authored-by: Zhiming Wang <[email protected]>
|
GH-12101 is a backport of this pull request to the 3.7 branch. |
GH-12101) …mum_version (GH-11894). (cherry picked from commit ae2ea33) Co-authored-by: Zhiming Wang <[email protected]>
|
Thank you for the PR, @zmwangx! |
7 participants
ssl.minimum_versionandssl.maximum_versionwere introduced in Python 3.7, alongsidessl.TLSVersionand such. Not havingversionaddeddirectives is somewhat confusing.This is trivial enough and warrants skip issue and skip news.