From: Harmon <Harmon758@gmail.com>
Date: Sat, 10 Apr 2021 15:23:11 +0000 (-0500)
Subject: Update and improve documentation for API.destroy_mute
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=023bf962cbf19f98405803d5de57d9fe5088151b;p=tweepy.git

Update and improve documentation for API.destroy_mute

Automatically use docstring for documentation
Improve method and documentation order
Remove id parameter from documentation
---

diff --git a/docs/api.rst b/docs/api.rst
index e2e5024..92e15da 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -185,6 +185,8 @@ Mute, block, and report users
 
 .. automethod:: API.create_mute
 
+.. automethod:: API.destroy_mute
+
 
 Direct Message Methods
 ----------------------
@@ -256,19 +258,6 @@ Account Methods
    :rtype: :class:`JSON` object
 
 
-Mute Methods
-------------
-
-.. method:: API.destroy_mute(id/screen_name/user_id)
-
-   Un-mutes the user specified in the ID parameter for the authenticating user.
-
-   :param id: |uid|
-   :param screen_name: |screen_name|
-   :param user_id: |user_id|
-   :rtype: :class:`User` object
-
-
 Spam Reporting Methods
 ----------------------
 
diff --git a/tweepy/api.py b/tweepy/api.py
index 28705da..ac63bab 100644
--- a/tweepy/api.py
+++ b/tweepy/api.py
@@ -2158,6 +2158,26 @@ class API:
             ), **kwargs
         )
 
+    @payload('user')
+    def destroy_mute(self, **kwargs):
+        """destroy_mute(*, screen_name, user_id)
+
+        Un-mutes the user specified in the ID parameter for the authenticating
+        user.
+
+        :param screen_name: |screen_name|
+        :param user_id: |user_id|
+
+        :rtype: :class:`User` object
+
+        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-destroy
+        """
+        return self.request(
+            'POST', 'mutes/users/destroy', endpoint_parameters=(
+                'screen_name', 'user_id'
+            ), **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
@@ -2397,16 +2417,6 @@ class API:
             ), use_cache=False, **kwargs
         )
 
-    @payload('user')
-    def destroy_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-destroy
-        """
-        return self.request(
-            'POST', 'mutes/users/destroy', endpoint_parameters=(
-                'screen_name', 'user_id'
-            ), **kwargs
-        )
-
     @payload('user')
     def report_spam(self, **kwargs):
         """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-users-report_spam