Update documentation for API.get_list
authorHarmon <Harmon758@gmail.com>
Tue, 7 May 2019 05:41:10 +0000 (00:41 -0500)
committerGitHub <noreply@github.com>
Tue, 7 May 2019 05:41:10 +0000 (00:41 -0500)
Resolves #1201

docs/api.rst

index 49302cf3403703dcb4e3e2b58ffcd8f6e081ce5d..007ef64eee63d4e5eb198f5234ff4a5356c74f36 100644 (file)
@@ -659,13 +659,15 @@ List Methods
    :rtype: list of :class:`Status` objects
 
 
-.. method:: API.get_list(owner, slug)
+.. method:: API.get_list(list_id/slug, [owner_id/owner_screen_name])
 
-   Show the specified list. Private lists will only be shown if the
+   Returns the specified list. Private lists 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|
    :rtype: :class:`List` object