Update and improve documentation for API.get_status
authorHarmon <Harmon758@gmail.com>
Sat, 22 May 2021 13:24:45 +0000 (08:24 -0500)
committerHarmon <Harmon758@gmail.com>
Sat, 22 May 2021 13:24:45 +0000 (08:24 -0500)
tweepy/api.py

index e2c31643f4253c66f070b86812cd6f2752e7f9ea..2b0a029f83bb06c4391c2f8d800ca4711958d52a 100644 (file)
@@ -851,19 +851,31 @@ class API:
 
         Returns a single status specified by the ID parameter.
 
-        :param id: |sid|
-        :param trim_user: |trim_user|
-        :param include_my_retweet: A boolean indicating if any Tweets returned
-            that have been retweeted by the authenticating user should include
-            an additional current_user_retweet node, containing the ID of the
-            source status for the retweet.
-        :param include_entities: |include_entities|
-        :param include_ext_alt_text: |include_ext_alt_text|
-        :param include_card_uri: |include_card_uri|
+        Parameters
+        ----------
+        id:
+            |sid|
+        trim_user
+            |trim_user|
+        include_my_retweet:
+            A boolean indicating if any Tweets returned that have been
+            retweeted by the authenticating user should include an additional
+            current_user_retweet node, containing the ID of the source status
+            for the retweet.
+        include_entities
+            |include_entities|
+        include_ext_alt_text
+            |include_ext_alt_text|
+        include_card_uri
+            |include_card_uri|
 
-        :rtype: :class:`Status` object
+        Returns
+        -------
+        :class:`~tweepy.models.Status`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-show-id
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-show-id
         """
         return self.request(
             'GET', 'statuses/show', endpoint_parameters=(