From 093dbde93981c1255d49b30bd51916032dc15da3 Mon Sep 17 00:00:00 2001 From: Harmon Date: Sun, 1 Sep 2019 15:19:30 -0500 Subject: [PATCH] Add trim_user to documented parameters --- docs/api.rst | 7 ++----- docs/parameters.rst | 1 + 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 184b709..8d03a42 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -67,8 +67,7 @@ Timeline methods :param id_: A list of Tweet IDs to lookup, up to 100 :param include_entities: |include_entities| - :param trim_user: A boolean indicating if user IDs should be provided, - instead of full user information. Defaults to False. + :param trim_user: |trim_user| :param map_: A boolean indicating whether or not to include tweets that cannot be shown. Defaults to False. :rtype: list of :class:`Status` objects @@ -184,9 +183,7 @@ Status methods :param place_id: A place in the world. :param display_coordinates: Whether or not to put a pin on the exact coordinates a Tweet has been sent from. - :param trim_user: When set to either true, t, or 1, the response will - include a user object including only the author's ID. Omit this - parameter to receive the complete user object. + :param trim_user: |trim_user| :param enable_dmcommands: When set to true, enables shortcode commands for sending Direct Messages as part of the status text to send a Direct Message to a user. When set to false, disables this behavior and includes diff --git a/docs/parameters.rst b/docs/parameters.rst index 5b8a62c..db20c15 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -19,6 +19,7 @@ .. |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:: 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. +.. |trim_user| replace:: A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False. .. |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