Add version added and changed directives to documentation for Client
authorHarmon <Harmon758@gmail.com>
Mon, 25 Oct 2021 09:06:39 +0000 (04:06 -0500)
committerHarmon <Harmon758@gmail.com>
Mon, 25 Oct 2021 09:06:39 +0000 (04:06 -0500)
tweepy/client.py

index 367861239bcc293151f0434a0368a153a87f542f..fa78e36fb8ccb1eeb868b6b7a775a35398773bfc 100644 (file)
@@ -38,6 +38,8 @@ class Client:
 
     Twitter API v2 Client
 
+    .. versionadded:: 4.0
+
     Parameters
     ----------
     bearer_token : Optional[str]
@@ -1199,6 +1201,9 @@ class Client:
         The request succeeds with no action when the authenticated user sends a
         request to a user they're not following or have already unfollowed.
 
+        .. versionchanged:: 4.2
+            Renamed from :meth:`Client.unfollow`
+
         Parameters
         ----------
         target_user_id : Union[int, str]
@@ -1336,6 +1341,9 @@ class Client:
         request to a user they're already following, or if they're sending a
         follower request to a user that does not have public Tweets.
 
+        .. versionchanged:: 4.2
+            Renamed from :meth:`Client.follow`
+
         Parameters
         ----------
         target_user_id : Union[int, str]
@@ -1403,6 +1411,8 @@ class Client:
 
         Returns a list of users who are muted by the authenticating user.
 
+        .. versionadded:: 4.1
+
         Parameters
         ----------
         expansions : Union[List[str], str]
@@ -1588,6 +1598,11 @@ class Client:
 
         Return live or scheduled Spaces matching your specified search terms
 
+        .. versionadded:: 4.1
+
+        .. versionchanged:: 4.2
+            ``state`` is now an optional parameter.
+
         Parameters
         ----------
         query : str
@@ -1633,6 +1648,8 @@ class Client:
         specified user IDs if specified). Up to 100 comma-separated Space or
         user IDs can be looked up using this endpoint.
 
+        .. versionadded:: 4.1
+
         Parameters
         ----------
         ids : Union[List[str], str]
@@ -1686,6 +1703,8 @@ class Client:
         Returns a variety of information about a single Space specified by the
         requested ID.
 
+        .. versionadded:: 4.1
+
         Parameters
         ----------
         id : Union[List[str], str]
@@ -1717,6 +1736,8 @@ class Client:
     def delete_list(self, id):
         """Enables the authenticated user to delete a List that they own.
 
+        .. versionadded:: 4.2
+
         Parameters
         ----------
         id : Union[int, str]
@@ -1739,6 +1760,8 @@ class Client:
         """Enables the authenticated user to remove a member from a List they
         own.
 
+        .. versionadded:: 4.2
+
         Parameters
         ----------
         id : Union[int, str]
@@ -1762,6 +1785,8 @@ class Client:
     def unfollow_list(self, list_id):
         """Enables the authenticated user to unfollow a List.
 
+        .. versionadded:: 4.2
+
         Parameters
         ----------
         list_id : Union[int, str]
@@ -1785,6 +1810,8 @@ class Client:
     def unpin_list(self, list_id):
         """Enables the authenticated user to unpin a List.
 
+        .. versionadded:: 4.2
+
         Parameters
         ----------
         list_id : Union[int, str]
@@ -1809,6 +1836,8 @@ class Client:
         """Enables the authenticated user to update the meta data of a
         specified List that they own.
 
+        .. versionadded:: 4.2
+
         Parameters
         ----------
         id : Union[int, str]
@@ -1846,6 +1875,8 @@ class Client:
     def create_list(self, name, *, description=None, private=None):
         """Enables the authenticated user to create a List.
 
+        .. versionadded:: 4.2
+
         Parameters
         ----------
         name : str
@@ -1878,6 +1909,8 @@ class Client:
     def add_list_member(self, id, user_id):
         """Enables the authenticated user to add a member to a List they own.
 
+        .. versionadded:: 4.2
+
         Parameters
         ----------
         id : Union[int, str]
@@ -1901,6 +1934,8 @@ class Client:
     def follow_list(self, list_id):
         """Enables the authenticated user to follow a List.
 
+        .. versionadded:: 4.2
+
         Parameters
         ----------
         list_id : Union[int, str]
@@ -1924,6 +1959,8 @@ class Client:
     def pin_list(self, list_id):
         """Enables the authenticated user to pin a List.
 
+        .. versionadded:: 4.2
+
         Parameters
         ----------
         list_id : Union[int, str]
@@ -1951,6 +1988,8 @@ class Client:
 
         Returns a list of recent compliance jobs.
 
+        .. versionadded:: 4.1
+
         Parameters
         ----------
         type : str
@@ -1978,6 +2017,8 @@ class Client:
     def get_compliance_job(self, id):
         """Get a single compliance job with the specified ID.
 
+        .. versionadded:: 4.1
+
         Parameters
         ----------
         id : Union[int, str]
@@ -2004,6 +2045,8 @@ class Client:
 
         You can run one batch job at a time.
 
+        .. versionadded:: 4.1
+
         Parameters
         ----------
         type : str