Skip to content

Simplify SSLSocket / SSLObject doc string#9972

Merged
matrixise merged 1 commit intopython:masterfrom
tiran:sslcopydoc
May 17, 2019
Merged

Simplify SSLSocket / SSLObject doc string#9972
matrixise merged 1 commit intopython:masterfrom
tiran:sslcopydoc

Conversation

@tiran
Copy link
Copy Markdown
Member

@tiran tiran commented Oct 19, 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

Copy link
Copy Markdown
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, nice hack :)

Comment thread Lib/ssl.py Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nitpick: it's called a "docstring" (no space), no?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@tiran could you fix doc string? thanks

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>
@matrixise matrixise merged commit 80ed353 into python:master May 17, 2019
@miss-islington
Copy link
Copy Markdown
Contributor

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

@bedevere-bot
Copy link
Copy Markdown

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>
@matrixise
Copy link
Copy Markdown
Member

@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
Instead of maintaining the same docstring two times, let's copy common
docstrings from SSLObject methods and properties to SSLSocket.

(cherry picked from commit 80ed353)

Co-authored-by: Christian Heimes <christian@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants