From 07d7ca1043ab2ec13bb81d958d83d872e0ebb3ca Mon Sep 17 00:00:00 2001 From: Daniel Lefevre Date: Sat, 26 Dec 2020 14:21:40 -0500 Subject: [PATCH] Reordered parameters on user_timeline to correspond to Twitter API documentation, added missing 'trim_user', 'exclude_replies', 'include_rts' parameters --- docs/api.rst | 17 ++++++++++------- docs/parameters.rst | 1 + 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 3c30f4b..d75f9a6 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -58,12 +58,7 @@ Timeline methods :param since_id: |since_id| :param max_id: |max_id| :param trim_user: |trim_user| - :param exclude_replies: This parameter will prevent replies from appearing - in the returned timeline. Using ``exclude_replies`` - with the ``count`` parameter will mean you will - receive up-to count Tweets — this is because the - ``count`` parameter retrieves that many Tweets - before filtering out retweets and replies. + :param exclude_replies: |exclude_replies| :param include_entities: |include_entities| :rtype: list of :class:`Status` objects @@ -95,8 +90,16 @@ Timeline methods :param user_id: |user_id| :param screen_name: |screen_name| :param since_id: |since_id| - :param max_id: |max_id| :param count: |count| + :param max_id: |max_id| + :param trim_user: |trim_user| + :param exclude_replies: |exclude_replies| + :include_rts: When set to false , the timeline will strip any native + retweets (though they will still count toward both the + maximal length of the timeline and the slice selected + by the count parameter). Note: If you're using the + trim_user parameter in conjunction with include_rts, + the retweets will still contain a full user object. :rtype: list of :class:`Status` objects diff --git a/docs/parameters.rst b/docs/parameters.rst index 28c04f2..b1c76a6 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -4,6 +4,7 @@ .. |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|:: This parameter will prevent replies from appearing in the returned timeline. Using ``exclude_replies`` with the ``count`` parameter will mean you will receive up-to count Tweets — this is because the ``count`` parameter retrieves that many Tweets before filtering out retweets and replies. .. |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