Update documentation for API.lists_memberships
authorHarmon <Harmon758@gmail.com>
Wed, 4 Sep 2019 06:32:21 +0000 (01:32 -0500)
committerHarmon <Harmon758@gmail.com>
Wed, 4 Sep 2019 06:32:21 +0000 (01:32 -0500)
docs/api.rst

index 0e209e032b83f14f0061b97b5480f1e6a65ebf7a..b1ad56c8eb43ae5bb6111edc320b180a2fe3cc4f 100644 (file)
@@ -833,10 +833,18 @@ List Methods
    :rtype: list of :class:`List` objects
 
 
-.. method:: API.lists_memberships([cursor])
+.. method:: API.lists_memberships([screen_name], [user_id], \
+                                  [filter_to_owned_lists], [cursor])
 
-   List the lists the specified user has been added to.
+   Returns the lists the specified user has been added to. If ``user_id`` or
+   ``screen_name`` are not provided, the memberships for the authenticating
+   user are returned.
 
+   :param screen_name: |screen_name|
+   :param user_id: |user_id|
+   :param filter_to_owned_lists: A boolean indicating whether to return just
+      lists the authenticating user owns, and the user represented by
+      ``user_id`` or ``screen_name`` is a member of.
    :param cursor: |cursor|
    :rtype: list of :class:`List` objects