From: Harmon Date: Wed, 4 Sep 2019 06:32:21 +0000 (-0500) Subject: Update documentation for API.lists_memberships X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=d630f8e4a69b969532056caf382dbb3010f453e1;p=tweepy.git Update documentation for API.lists_memberships --- diff --git a/docs/api.rst b/docs/api.rst index 0e209e0..b1ad56c 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -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