Skip to content

Commit

Permalink
Merge pull request twisted#1213 from twisted/9751-sshtransportbase-xref
Browse files Browse the repository at this point in the history
[9751] Fix pydoctor warnings about SSHTransportBase

Author: twm
Reviewer: rodrigc
Fixes: ticket:9751
  • Loading branch information
rodrigc authored Mar 28, 2020
2 parents 5a81e41 + 1ace465 commit 34fd0bd
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
Empty file.
12 changes: 6 additions & 6 deletions src/twisted/conch/ssh/transport.py
Original file line number Diff line number Diff line change
Expand Up @@ -1235,8 +1235,8 @@ def _generateECPrivateKey(self):
Generate an private key for ECDH key exchange.
@rtype: The appropriate private key type matching C{self.kexAlg}:
L{EllipticCurvePrivateKey} for C{ecdh-sha2-nistp*}, or
L{X25519PrivateKey} for C{curve25519-sha256}.
L{ec.EllipticCurvePrivateKey} for C{ecdh-sha2-nistp*}, or
L{x25519.X25519PrivateKey} for C{curve25519-sha256}.
@return: The generated private key.
"""
if self.kexAlg.startswith(b'ecdh-sha2-nistp'):
Expand All @@ -1260,8 +1260,8 @@ def _encodeECPublicKey(self, ecPub):
Encode an elliptic curve public key to bytes.
@type ecPub: The appropriate public key type matching
C{self.kexAlg}: L{EllipticCurvePublicKey} for
C{ecdh-sha2-nistp*}, or L{X25519PublicKey} for
C{self.kexAlg}: L{ec.EllipticCurvePublicKey} for
C{ecdh-sha2-nistp*}, or L{x25519.X25519PublicKey} for
C{curve25519-sha256}.
@param ecPub: The public key to encode.
Expand Down Expand Up @@ -1290,8 +1290,8 @@ def _generateECSharedSecret(self, ecPriv, theirECPubBytes):
Generate a shared secret for ECDH key exchange.
@type ecPriv: The appropriate private key type matching
C{self.kexAlg}: L{EllipticCurvePrivateKey} for
C{ecdh-sha2-nistp*}, or L{X25519PrivateKey} for
C{self.kexAlg}: L{ec.EllipticCurvePrivateKey} for
C{ecdh-sha2-nistp*}, or L{x25519.X25519PrivateKey} for
C{curve25519-sha256}.
@param ecPriv: Our private key.
Expand Down
1 change: 1 addition & 0 deletions src/twisted/python/_release.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
intersphinxURLs = [
u"https://docs.python.org/2/objects.inv",
u"https://docs.python.org/3/objects.inv",
u"https://cryptography.io/en/latest/objects.inv",
u"https://pyopenssl.readthedocs.io/en/stable/objects.inv",
u"https://hyperlink.readthedocs.io/en/stable/objects.inv",
u"https://twisted.github.io/constantly/docs/objects.inv",
Expand Down

0 comments on commit 34fd0bd

Please sign in to comment.