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

index 4eb5c3574ba6e7a604324564ecd5ea3d13b7f1fc..816f7b93fcd74d2cc54e9bdd376a0cca8702000e 100644 (file)
@@ -3070,12 +3070,20 @@ class API:
         Mutes the user specified in the ID parameter for the authenticating
         user.
 
-        :param screen_name: |screen_name|
-        :param user_id: |user_id|
+        Parameters
+        ----------
+        screen_name
+            |screen_name|
+        user_id
+            |user_id|
 
-        :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-mutes-users-create
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-create
         """
         return self.request(
             'POST', 'mutes/users/create', endpoint_parameters=(