From: Harmon <Harmon758@gmail.com>
Date: Sat, 10 Apr 2021 14:49:53 +0000 (-0500)
Subject: Update and improve documentation for API.mutes
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=9faa0e640d797981250b8cd377e27d254dc257c1;p=tweepy.git

Update and improve documentation for API.mutes

Automatically use docstring for documentation
Improve method and documentation order
---

diff --git a/docs/api.rst b/docs/api.rst
index 11ee389..7c76c67 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -177,6 +177,8 @@ Mute, block, and report users
 
 .. automethod:: API.mutes_ids
 
+.. automethod:: API.mutes
+
 
 Direct Message Methods
 ----------------------
@@ -296,16 +298,6 @@ Mute Methods
    :rtype: :class:`User` object
 
 
-.. method:: API.mutes([cursor], [include_entities], [skip_status])
-
-   Returns an array of user objects the authenticating user has muted.
-
-   :param cursor: |cursor|
-   :param include_entities: |include_entities|
-   :param skip_status: |skip_status|
-   :rtype: list of :class:`User` objects
-
-
 Spam Reporting Methods
 ----------------------
 
diff --git a/tweepy/api.py b/tweepy/api.py
index 385cfba..380923d 100644
--- a/tweepy/api.py
+++ b/tweepy/api.py
@@ -2070,6 +2070,27 @@ class API:
             ), **kwargs
         )
 
+    @pagination(mode='cursor')
+    @payload('user', list=True)
+    def mutes(self, **kwargs):
+        """mutes(*, cursor, include_entities, skip_status)
+
+        Returns an array of user objects the authenticating user has muted.
+
+        :param cursor: |cursor|
+        :param include_entities: |include_entities|
+        :param skip_status: |skip_status|
+
+        :rtype: list of :class:`User` objects
+
+        :reference: 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=(
+                'cursor', 'include_entities', 'skip_status'
+            ), **kwargs
+        )
+
     def media_upload(self, filename, *, file=None, chunked=False,
                      media_category=None, additional_owners=None, **kwargs):
         """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview
@@ -2329,17 +2350,6 @@ class API:
             ), **kwargs
         )
 
-    @pagination(mode='cursor')
-    @payload('user', list=True)
-    def mutes(self, **kwargs):
-        """ :reference: 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=(
-                'cursor', 'include_entities', 'skip_status'
-            ), **kwargs
-        )
-
     @payload('user')
     def create_mute(self, **kwargs):
         """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-create