Simplify SSLSocket / SSLObject doc string #9972
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
vstinner
approved these changes
Oct 24, 2018
Lib/ssl.py
Outdated
| @@ -781,6 +781,12 @@ def verify_client_post_handshake(self): | |||
| return self._sslobj.verify_client_post_handshake() | |||
|
|
|||
|
|
|||
| def _sslcopydoc(func): | |||
| """Copy doc string from SSLObject to SSLSocket""" | |||
There was a problem hiding this comment.
nitpick: it's called a "docstring" (no space), no?
There was a problem hiding this comment.
@tiran could you fix doc string? thanks
matrixise
approved these changes
Oct 24, 2018
Instead of maintaining the same doc string two times, let's copy common doc strings from SSLObject methods and properties to SSLSocket. Signed-off-by: Christian Heimes <christian@python.org>
|
Thanks @tiran for the PR, and @matrixise for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7. |
|
GH-13384 is a backport of this pull request to the 3.7 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 17, 2019
Instead of maintaining the same doc string two times, let's copy common doc strings from SSLObject methods and properties to SSLSocket. Signed-off-by: Christian Heimes <christian@python.org> (cherry picked from commit 80ed353) Co-authored-by: Christian Heimes <christian@python.org>
|
@tiran thanks |
matrixise
pushed a commit
to matrixise/cpython
that referenced
this pull request
May 17, 2019
Instead of maintaining the same doc string two times, let's copy common doc strings from SSLObject methods and properties to SSLSocket. Signed-off-by: Christian Heimes <christian@python.org> (cherry picked from commit 80ed353) Co-authored-by: Christian Heimes <christian@python.org>
matrixise
pushed a commit
that referenced
this pull request
May 17, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Instead of maintaining the same doc string two times, let's copy common
doc strings from SSLObject methods and properties to SSLSocket.
Signed-off-by: Christian Heimes christian@python.org