[tor-commits] [ooni-probe/develop] Cleanup docstrings for getX509Name() and getPublicKey() functions.

[isis at torproject.org]

commit 724688ab14393846a77c3b0b2d064fbc641a9b58
Author: Isis Lovecruft <isis at torproject.org>
Date:   Mon Apr 22 00:47:20 2013 +0000

    Cleanup docstrings for getX509Name() and getPublicKey() functions.
---
 nettests/experimental/tls_handshake.py |    8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/nettests/experimental/tls_handshake.py b/nettests/experimental/tls_handshake.py
index d2f58a3..a52ccdc 100644
--- a/nettests/experimental/tls_handshake.py
+++ b/nettests/experimental/tls_handshake.py
@@ -250,8 +250,7 @@ class HandshakeTest(nettest.NetTestCase):
 
     @staticmethod
     def getX509Name(certificate, get_components=False):
-        """
-        Get the DER encoded form of the Name portions of and X509 certificate.
+        """Get the DER-encoded form of the Name fields of an X509 certificate.
 
         @param certificate: A :class:`OpenSSL.crypto.X509Name` object.
         @param get_components: A boolean. If True, returns a list of tuples of
@@ -281,10 +280,9 @@ class HandshakeTest(nettest.NetTestCase):
 
     @staticmethod
     def getPublicKey(key):
-        """
-        Get the PEM-encoded format of a host certificate's public key.
+        """Get the PEM-encoded format of a host certificate's public key.
 
-        @param key: A :class:`OpenSSL.crypto.PKey` object.
+        :param key: A :class:`OpenSSL.crypto.PKey <crypto.PKey>` object.
         """
         try:
             assert isinstance(key, crypto.PKey), \