From b45b95bf20e7057fdef62992e36776390551ea0f Mon Sep 17 00:00:00 2001 From: Daniel Lefevre Date: Sat, 19 Dec 2020 18:01:29 -0500 Subject: [PATCH] Removed 'exclude_replies' from parameters.rst and added description to home_timeline docstring in api.rst --- docs/api.rst | 6 +++++- docs/parameters.rst | 1 - 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 42d2c8f..833b3b0 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -58,7 +58,11 @@ Timeline methods :param since_id: |since_id| :param max_id: |max_id| :param trim_user: |trim_user| - :param exclude_replies: |exclude_replies| + :param exclude_replies: A boolean which will prevent reply tweets from + being included with the returned timeline. Note + that the API will return a number of tweets equal + to the count parameter before replies are filtered + out. Defaults to True. :rtype: list of :class:`Status` objects diff --git a/docs/parameters.rst b/docs/parameters.rst index ae4aa8f..28c04f2 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -4,7 +4,6 @@ .. |cursor| replace:: Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list. .. |date| replace:: Permits specifying a start date for the report. The date should be formatted YYYY-MM-DD. .. |exclude| replace:: Setting this equal to hashtags will remove all hashtags from the trends list. -.. |exclude_replies| replace:: A boolean which will prevent reply tweets from being included with the returned timeline. Note that the API will return a number of tweets equal to the count parameter before replies are filtered out. Defaults to True. .. |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_card_uri| replace:: A boolean indicating if the retrieved Tweet should include a card_uri attribute when there is an ads card attached to the Tweet and when that card was attached using the card_uri value. .. |include_entities| replace:: The entities node will not be included when set to false. Defaults to true. -- 2.25.1