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

index 22123260541f15c344203d4ea2d28783831e4740..1a626ae3075a64ec8b5e86a1a49f6e3c603538d3 100644 (file)
@@ -2973,13 +2973,22 @@ class API:
 
         Returns an array of user objects the authenticating user has muted.
 
-        :param cursor: |cursor|
-        :param include_entities: |include_entities|
-        :param skip_status: |skip_status|
+        Parameters
+        ----------
+        cursor
+            |cursor|
+        include_entities
+            |include_entities|
+        skip_status
+            |skip_status|
 
-        :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-mutes-users-list
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-list
         """
         return self.request(
             'GET', 'mutes/users/list', endpoint_parameters=(