PKey docstring cleanup

This commit is contained in:
Jeff Forcier 2014-02-24 10:05:25 -08:00
parent 24cc59b64d
commit f76485f766
1 changed files with 9 additions and 8 deletions

View File

@ -52,14 +52,14 @@ class PKey (object):
``data`` is given, the key's public part(s) will be filled in from ``data`` is given, the key's public part(s) will be filled in from
the string. the string.
:param msg: an optional SSH `.Message` containing a public key of this :param msg:
type. an optional SSH `.Message` containing a public key of this type.
:type msg: `.Message` :type msg: `.Message`
:param data: an optional string containing a public key of this type :param str data: an optional string containing a public key of this type
:type data: str
:raises SSHException: if a key cannot be created from the ``data`` or :raises SSHException:
``msg`` given, or no key was passed in. if a key cannot be created from the ``data`` or ``msg`` given, or
no key was passed in.
""" """
pass pass
@ -96,8 +96,9 @@ class PKey (object):
""" """
Return the name of this private key implementation. Return the name of this private key implementation.
:return: name of this private key type, in SSH terminology (for :return:
example, ``"ssh-rsa"``). name of this private key type, in SSH terminology (for example,
``"ssh-rsa"``).
:rtype: str :rtype: str
""" """
return '' return ''