Docstring fixes

jsmnbom · jsmnbom · commit 55faee6ae565 · 2018-08-25T22:44:36.000+02:00
diff --git a/telegram/passport/credentials.py b/telegram/passport/credentials.py
@@ -55,11 +55,10 @@ def decrypt(secret, hash, data, file=False):
             b64decode it.
 
     Raises:
-        :class:`TelegramDecryptionError`: Raised if the given hash does not match the hash of
-            decrypted data
+        :class:`TelegramDecryptionError`: Given hash does not match hash of decrypted data.
 
     Returns:
-        :obj:`bytes`: The decrypted data as bytes
+        :obj:`bytes`: The decrypted data as bytes.
 
     """
     # First make sure that if secret, hash, or data was base64 encoded, to decode it into bytes
@@ -153,12 +152,11 @@ def de_json(cls, data, bot):
     @property
     def decrypted_secret(self):
         """
-        :obj:`str`: The secret as decrypted using the bot's private key.
+        :obj:`str`: Lazily decrypt and return secret.
 
         Raises:
-            telegram.TelegramDecryptionError: If a decryption error happened while attempting
-                to decrypt the data. This is most often a wrong/missing private_key, but will
-                also happen in cases of tampered data.
+            telegram.TelegramDecryptionError: Decryption failed. Usually due to bad
+                private/public key but can also suggest malformed/tampered data.
         """
         if not self._decrypted_secret:
             # Try decrypting according to step 1 at
@@ -181,14 +179,13 @@ def decrypted_secret(self):
     @property
     def decrypted_data(self):
         """
-        :class:`telegram.Credentials`: Decrypted credentials that were used to decrypt
-        the data. This object also contains the user specified payload as
-        `decrypted_data.payload`.
+        :class:`telegram.Credentials`: Lazily decrypt and return credentials data. This object
+            also contains the user specified payload as
+            `decrypted_data.payload`.
 
         Raises:
-            telegram.TelegramDecryptionError: If a decryption error happened while attempting
-                to decrypt the data. This is most often a wrong/missing private_key, but will
-                also happen in cases of tampered data.
+            telegram.TelegramDecryptionError: Decryption failed. Usually due to bad
+                private/public key but can also suggest malformed/tampered data.
         """
         if not self._decrypted_data:
             self._decrypted_data = Credentials.de_json(decrypt_json(self.decrypted_secret,
diff --git a/telegram/passport/passportdata.py b/telegram/passport/passportdata.py
@@ -75,15 +75,12 @@ def to_dict(self):
     @property
     def decrypted_data(self):
         """
-        List[:class:`telegram.EncryptedPassportElement`]: Decrypted array with information about
-        documents and other Telegram Passport elements that was shared with the bot. This means
-        that despite its name, :class:`telegram.EncryptedPassportElement`, will in fact be
-        decrypted.
+        List[:class:`telegram.EncryptedPassportElement`]: Lazily decrypt and return information
+            about documents and other Telegram Passport elements which were shared with the bot.
 
         Raises:
-            telegram.TelegramDecryptionError: If a decryption error happened while attempting
-                to decrypt the data. This is most often a wrong/missing private_key, but will
-                also happen in cases of tampered data.
+            telegram.TelegramDecryptionError: Decryption failed. Usually due to bad
+                private/public key but can also suggest malformed/tampered data.
         """
         if not self._decrypted_data:
             self._decrypted_data = [
@@ -98,13 +95,12 @@ def decrypted_data(self):
     @property
     def decrypted_credentials(self):
         """
-        :class:`telegram.Credentials`: Decrypted credentials that were used to decrypt
-        the data. This object also contains the user specified payload as
-        `decrypted_data.payload`.
+        :class:`telegram.Credentials`: Lazily decrypt and return credentials that were used
+            to decrypt the data. This object also contains the user specified payload as
+            `decrypted_data.payload`.
 
         Raises:
-            telegram.TelegramDecryptionError: If a decryption error happened while attempting
-                to decrypt the data. This is most often a wrong/missing private_key, but will
-                also happen in cases of tampered data.
+            telegram.TelegramDecryptionError: Decryption failed. Usually due to bad
+                private/public key but can also suggest malformed/tampered data.
         """
         return self.credentials.decrypted_data
