From 685612f5d3c0d1ee913266c853743086a9c550df Mon Sep 17 00:00:00 2001 From: Harmon Date: Tue, 7 May 2019 00:30:59 -0500 Subject: [PATCH] Update documentation for API.is_list_member to API.show_list_member --- docs/api.rst | 13 ++++++++----- docs/parameters.rst | 5 ++++- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 23f1166..49302cf 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -699,14 +699,17 @@ List Methods :rtype: list of :class:`User` objects -.. method:: API.is_list_member(owner, slug, id) +.. method:: API.show_list_member(list_id/slug, screen_name/user_id, [owner_id/owner_screen_name]) - Check if a user is a member of the specified list. + Check if the specified user is a member of the specified list. - :param owner: |list_owner| + :param list_id: |list_id| :param slug: |slug| - :param id: the ID of the user to check - :rtype: :class:`User` object if user is a member of list, otherwise False. + :param screen_name: |screen_name| + :param user_id: |user_id| + :param owner_id: |owner_id| + :param owner_screen_name: |owner_screen_name| + :rtype: :class:`User` object if user is a member of list .. method:: API.subscribe_list(owner, slug) diff --git a/docs/parameters.rst b/docs/parameters.rst index f95004d..313fde4 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -6,15 +6,18 @@ .. |exclude| replace:: Setting this equal to hashtags will remove all hashtags from the trends list. .. |full_text| replace:: A boolean indicating whether or not the full text of a message should be returned. If False the message text returned will be truncated to 140 chars. Defaults to False. .. |include_user_entities| replace:: The user object entities node will not be included when set to false. Defaults to true. +.. |list_id| replace:: The numerical id of the list. .. |list_mode| replace:: Whether your list is public or private. Values can be public or private. Lists are public by default if no mode is specified. .. |list_owner| replace:: the screen name of the owner of the list .. |max_id| replace:: Returns only statuses with an ID less than (that is, older than) or equal to the specified ID. +.. |owner_id| replace:: The user ID of the user who owns the list being requested by a slug. +.. |owner_screen_name| replace:: The screen name of the user who owns the list being requested by a slug. .. |page| replace:: Specifies the page of results to retrieve. Note: there are pagination limits. .. |screen_name| replace:: Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID. .. |sid| replace:: The numerical ID of the status. .. |since_id| replace:: Returns only statuses with an ID greater than (that is, more recent than) the specified ID. .. |skip_status| replace:: When set to either true, t or 1 statuses will not be included in the returned user objects. Defaults to false. -.. |slug| replace:: the slug name or numerical ID of the list +.. |slug| replace:: You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters. .. |uid| replace:: Specifies the ID or screen name of the user. .. |user_id| replace:: Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name. -- 2.25.1