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

index 5c20c095ae6e16d1b5ba3fae161231b083ed6ed0..ca6c5b4957903647c55edb531d8f7b7c15be03e9 100644 (file)
@@ -2915,13 +2915,22 @@ class API:
         Returns an array of user objects that the authenticating user is
         blocking.
 
-        :param include_entities: |include_entities|
-        :param skip_status: |skip_status|
-        :param cursor: |cursor|
+        Parameters
+        ----------
+        include_entities
+            |include_entities|
+        skip_status
+            |skip_status|
+        cursor
+            |cursor|
 
-        :rtype: list of :class:`User` objects
+        Returns
+        -------
+        :py:class:`List`\ [:class:`~tweepy.models.User`]
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
         """
         return self.request(
             'GET', 'blocks/list', endpoint_parameters=(