diff options
author | Sybren A. Stüvel <sybren@stuvel.eu> | 2016-01-22 14:20:15 +0100 |
---|---|---|
committer | Sybren A. Stüvel <sybren@stuvel.eu> | 2016-01-22 14:20:15 +0100 |
commit | ca0e4e576450b91f50b2580dd8903071cad973be (patch) | |
tree | ae9eca07fa7ff664acade85649920eefe9b720a4 /rsa/pem.py | |
parent | 1681a0b2f84a4a252c71b87de870a2816de06fdf (diff) | |
download | rsa-git-ca0e4e576450b91f50b2580dd8903071cad973be.tar.gz |
Fixed some docstrings to use Sphinx-compatible notation
Diffstat (limited to 'rsa/pem.py')
-rw-r--r-- | rsa/pem.py | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -35,12 +35,12 @@ def _markers(pem_marker): def load_pem(contents, pem_marker): """Loads a PEM file. - @param contents: the contents of the file to interpret - @param pem_marker: the marker of the PEM content, such as 'RSA PRIVATE KEY' + :param contents: the contents of the file to interpret + :param pem_marker: the marker of the PEM content, such as 'RSA PRIVATE KEY' when your file has '-----BEGIN RSA PRIVATE KEY-----' and '-----END RSA PRIVATE KEY-----' markers. - @return the base64-decoded content between the start and end markers. + :return: the base64-decoded content between the start and end markers. @raise ValueError: when the content is invalid, for example when the start marker cannot be found. @@ -97,12 +97,12 @@ def load_pem(contents, pem_marker): def save_pem(contents, pem_marker): """Saves a PEM file. - @param contents: the contents to encode in PEM format - @param pem_marker: the marker of the PEM content, such as 'RSA PRIVATE KEY' + :param contents: the contents to encode in PEM format + :param pem_marker: the marker of the PEM content, such as 'RSA PRIVATE KEY' when your file has '-----BEGIN RSA PRIVATE KEY-----' and '-----END RSA PRIVATE KEY-----' markers. - @return the base64-encoded content between the start and end markers. + :return: the base64-encoded content between the start and end markers. """ |