Update and improve documentation for API.destroy_status
authorHarmon <Harmon758@gmail.com>
Sat, 22 May 2021 17:43:41 +0000 (12:43 -0500)
committerHarmon <Harmon758@gmail.com>
Sat, 22 May 2021 17:43:41 +0000 (12:43 -0500)
tweepy/api.py

index 644d47505b05203db84b9bd260601a3b9aa59250..70e2a30007999a2e1268e7c9decc6470108cd870 100644 (file)
@@ -947,12 +947,20 @@ class API:
         Destroy the status specified by the ``id`` parameter. The authenticated
         user must be the author of the status to destroy.
 
-        :param id: |sid|
-        :param trim_user: |trim_user|
+        Parameters
+        ----------
+        id
+            |sid|
+        trim_user
+            |trim_user|
 
-        :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/post-statuses-destroy-id
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-destroy-id
         """
         return self.request(
             'POST', f'statuses/destroy/{id}', endpoint_parameters=(