Update documentation for API.list_subscribers
authorHarmon <Harmon758@gmail.com>
Wed, 4 Sep 2019 07:30:26 +0000 (02:30 -0500)
committerHarmon <Harmon758@gmail.com>
Wed, 4 Sep 2019 07:30:26 +0000 (02:30 -0500)
docs/api.rst

index 23ee1b40e3c3294ccadf8ac8b22fc1e5f28243a2..d568147ef96f4d3985d91f4db871b3212adc5d31 100644 (file)
@@ -1011,12 +1011,16 @@ List Methods
    :rtype: :class:`List` object
 
 
-.. method:: API.list_subscribers(owner, slug, [cursor])
+.. method:: API.list_subscribers(list_id/slug, [owner_id/owner_screen_name], \
+                                 [cursor])
 
-   Returns the subscribers of the specified list.
+   Returns the subscribers of the specified list. Private list subscribers will
+   only be shown if the authenticated user owns the specified list.
 
-   :param owner: |list_owner|
+   :param list_id: |list_id|
    :param slug: |slug|
+   :param owner_id: |owner_id|
+   :param owner_screen_name: |owner_screen_name|
    :param cursor: |cursor|
    :rtype: list of :class:`User` objects