Update documentation for API.update_list
authorHarmon <Harmon758@gmail.com>
Tue, 2 Jul 2019 00:31:54 +0000 (19:31 -0500)
committerGitHub <noreply@github.com>
Tue, 2 Jul 2019 00:31:54 +0000 (19:31 -0500)
docs/api.rst

index 5aa64d67effde96e1b52c520daeb73aecf39511b..13eb931a132c8028fb5700e384293e4a9083ca23 100644 (file)
@@ -629,15 +629,18 @@ List Methods
    :rtype: :class:`List` object
 
 
-.. method:: API.update_list(slug, [name], [mode], [description])
+.. method:: API.update_list(list_id/slug, [name], [mode], [description], [owner_screen_name/owner_id])
 
-   Updates the specified list. Note: this current throws a 500. Twitter
-   is looking into the issue.
+   Updates the specified list.
+   The authenticated user must own the list to be able to update it.
 
+   :param list_id: |list_id|
    :param slug: |slug|
-   :param name: What you'd like to change the lists name to.
+   :param name: The name for the list.
    :param mode: |list_mode|
-   :param description: What you'd like to change the list description to.
+   :param description: The description to give the list.
+   :param owner_screen_name: |owner_screen_name|
+   :param owner_id: |owner_id|
    :rtype: :class:`List` object