Indicate parameters as optional in documentation for Client.get_spaces
authorHarmon <Harmon758@gmail.com>
Sat, 26 Feb 2022 18:48:49 +0000 (12:48 -0600)
committerHarmon <Harmon758@gmail.com>
Sat, 26 Feb 2022 18:48:49 +0000 (12:48 -0600)
Properly indicate ids and user_ids parameters as optional in documentation for Client.get_spaces

tweepy/client.py

index f285489bef18bc447c7d70b390bcfcb7ba6c458e..050e758ad2f86f26ad5b0afe64c1141d2364fc48 100644 (file)
@@ -1967,7 +1967,8 @@ class Client(BaseClient):
     # Spaces lookup
 
     def get_spaces(self, *, ids=None, user_ids=None, **params):
-        """get_spaces(*, ids, user_ids, expansions, space_fields, user_fields)
+        """get_spaces(*, ids=None, user_ids=None, expansions, space_fields, \
+                      user_fields)
 
         Returns details about multiple live or scheduled Spaces (created by the
         specified user IDs if specified). Up to 100 comma-separated Space or
@@ -1977,9 +1978,9 @@ class Client(BaseClient):
 
         Parameters
         ----------
-        ids : list[str] | str
+        ids : list[str] | str | None
             A comma separated list of Spaces (up to 100).
-        user_ids : list[int | str] | str
+        user_ids : list[int | str] | str | None
             A comma separated list of user IDs (up to 100).
         expansions : list[str] | str
             :ref:`expansions_parameter`