From: Harmon Date: Thu, 27 May 2021 11:45:11 +0000 (-0500) Subject: Update and improve documentation for API.report_spam X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=fe284395d951cf313f215575693068cb120f09cb;p=tweepy.git Update and improve documentation for API.report_spam --- diff --git a/tweepy/api.py b/tweepy/api.py index 8e6ba08..4f8a668 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -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=(