From: Harmon Date: Mon, 24 May 2021 11:36:57 +0000 (-0500) Subject: Update and improve documentation for API.lists_memberships X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=81ebe5ffc2c83254a6af72649713dde30884e016;p=tweepy.git Update and improve documentation for API.lists_memberships --- diff --git a/tweepy/api.py b/tweepy/api.py index adfbc93..30ba1fe 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -1412,17 +1412,28 @@ class API: or ``screen_name`` are not provided, the memberships for the authenticating user are returned. - :param user_id: |user_id| - :param screen_name: |screen_name| - :param count: |count| - :param cursor: |cursor| - :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. + Parameters + ---------- + user_id + |user_id| + screen_name + |screen_name| + count + |count| + cursor + |cursor| + 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. - :rtype: list of :class:`List` objects + Returns + ------- + :py:class:`List`\ [:class:`~tweepy.models.List`] - :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-memberships + References + ---------- + https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-memberships """ return self.request( 'GET', 'lists/memberships', endpoint_parameters=(