Update and improve documentation for API.get_direct_message
authorHarmon <Harmon758@gmail.com>
Thu, 27 May 2021 11:58:12 +0000 (06:58 -0500)
committerHarmon <Harmon758@gmail.com>
Thu, 27 May 2021 11:58:12 +0000 (06:58 -0500)
tweepy/api.py

index 3c0e40c5eeead0c3e3fafd06a979a6436e07e884..8f4993d6a9e457bbdfed24357b76c0dfb63d827b 100644 (file)
@@ -3210,11 +3210,18 @@ class API:
 
         Returns a specific direct message.
 
-        :param id: The ID of the Direct Message event that should be returned.
+        Parameters
+        ----------
+        id
+            The ID of the Direct Message event that should be returned.
 
-        :rtype: :class:`DirectMessage` object
+        Returns
+        -------
+        :class:`~tweepy.models.DirectMessage`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/get-event
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/get-event
         """
         return self.request(
             'GET', 'direct_messages/events/show', endpoint_parameters=(