From: Harmon <Harmon758@gmail.com>
Date: Sat, 22 May 2021 17:51:52 +0000 (-0500)
Subject: Update and improve documentation for API.unretweet
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=ffc3d39241dbbd0d64869a377b2ff18c50cf8d16;p=tweepy.git

Update and improve documentation for API.unretweet
---

diff --git a/tweepy/api.py b/tweepy/api.py
index 11c7c36..8ec68c0 100644
--- a/tweepy/api.py
+++ b/tweepy/api.py
@@ -1002,12 +1002,20 @@ class API:
         Untweets a retweeted status. Requires the ID of the retweet to
         unretweet.
 
-        :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-unretweet-id
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-unretweet-id
         """
         return self.request(
             'POST', f'statuses/unretweet/{id}', endpoint_parameters=(