diff options
author | Matěj Cepl <mcepl@cepl.eu> | 2017-04-20 17:12:51 +0200 |
---|---|---|
committer | Matěj Cepl <mcepl@cepl.eu> | 2017-09-20 21:13:34 +0200 |
commit | 82db77e1a9c1d03534a9c0b73d51801ba7257240 (patch) | |
tree | d19e87bcb0d8128d3bc6396ee9406de9cd1e9012 /M2Crypto/BIO.py | |
parent | c0b300a5e4532b549f18b5526604219d717e2582 (diff) | |
download | m2crypto-82db77e1a9c1d03534a9c0b73d51801ba7257240.tar.gz |
Change JavaDoc parameters to the Sphinx convention.
Diffstat (limited to 'M2Crypto/BIO.py')
-rw-r--r-- | M2Crypto/BIO.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/M2Crypto/BIO.py b/M2Crypto/BIO.py index c05e59b..3cd4230 100644 --- a/M2Crypto/BIO.py +++ b/M2Crypto/BIO.py @@ -98,7 +98,7 @@ class BIO(object): # type: (AnyStr) -> int """ - @return: either data written, or [0, -1] for nothing written, + :return: either data written, or [0, -1] for nothing written, -2 not implemented """ if not self.writeable(): @@ -115,7 +115,7 @@ class BIO(object): # type: () -> None """ - @return: 1 for success, and 0 or -1 for failure + :return: 1 for success, and 0 or -1 for failure """ m2.bio_flush(self.bio) @@ -123,7 +123,7 @@ class BIO(object): # type: () -> int """ Sets the bio to its initial state - @return: 1 for success, and 0 or -1 for failure + :return: 1 for success, and 0 or -1 for failure """ return m2.bio_reset(self.bio) @@ -228,7 +228,7 @@ class File(BIO): """ Object interface to BIO_s_pyfd - This class interfaces Python to OpenSSL functions that expect BIO *. For + This class interfaces Python to OpenSSL functions that expect BIO \*. For general file manipulation in Python, use Python's builtin file object. """ @@ -254,7 +254,7 @@ class File(BIO): # type: () -> int """ Sets the bio to its initial state - @return: 0 for success, and -1 for failure + :return: 0 for success, and -1 for failure """ return super(File, self).reset() |