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

index 1a626ae3075a64ec8b5e86a1a49f6e3c603538d3..2c7f88d09ddf9cdd2ee06a9a5ad2819b98d687bd 100644 (file)
@@ -3005,14 +3005,24 @@ class API:
         mentions or timeline (unless retweeted by another user). If a follow or
         friend relationship exists it is destroyed.
 
-        :param screen_name: |screen_name|
-        :param user_id: |user_id|
-        :param include_entities: |include_entities|
-        :param skip_status: |skip_status|
+        Parameters
+        ----------
+        screen_name
+            |screen_name|
+        user_id
+            |user_id|
+        include_entities
+            |include_entities|
+        skip_status
+            |skip_status|
 
-        :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-blocks-create
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-blocks-create
         """
         return self.request(
             'POST', 'blocks/create', endpoint_parameters=(