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

index 0411d3b2536f6bacccb896f7d23bca7766ef05b0..1ac2096c85591c515e844bfbcd280d8cb854a546 100644 (file)
@@ -989,12 +989,14 @@ List Methods
    :rtype: :class:`User` object if user is a member of list
 
 
-.. method:: API.subscribe_list(owner, slug)
+.. method:: API.subscribe_list(list_id/slug, [owner_id/owner_screen_name])
 
-   Make the authenticated user follow the specified list.
+   Subscribes the authenticated user to 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|
    :rtype: :class:`List` object