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

index 8e6ba08740f9fc0ee47b67140e85a7db9d66c6be..4f8a668cf206595d87769ba77664789485149678 100644 (file)
@@ -3125,14 +3125,21 @@ class API:
 
         Report the specified user as a spam account to Twitter.
 
-        :param screen_name: |screen_name|
-        :param user_id: |user_id|
-        :param perform_block: A boolean indicating if the reported account
-                              should be blocked. Defaults to True.
+        screen_name
+            |screen_name|
+        user_id
+            |user_id|
+        perform_block
+            A boolean indicating if the reported account should be blocked.
+            Defaults to True.
 
-        :rtype: :class:`User` object
+        Returns
+        -------
+        :class:`~tweepy.models.User`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-users-report_spam
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-users-report_spam
         """
         return self.request(
             'POST', 'users/report_spam', endpoint_parameters=(