Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Remove include_rts parameter from documentation

  • Loading branch information...
commit db823110dbc3752aa6dbc045a751154a13c75ac9 1 parent 938ccaa
@sferik sferik authored
Showing with 2 additions and 4 deletions.
  1. +2 −4 lib/twitter/client/timelines.rb
View
6 lib/twitter/client/timelines.rb
@@ -32,7 +32,7 @@ def home_timeline(options={})
# Returns the 20 most recent mentions (statuses containing @username) for the authenticating user
#
# @see https://dev.twitter.com/docs/api/1/get/statuses/mentions
- # @note This method can only return up to 800 statuses. If the :include_rts option is set, only 800 statuses, including retweets if they exist, can be returned.
+ # @note This method can only return up to 800 statuses.
# @rate_limited Yes
# @requires_authentication Yes
# @param options [Hash] A customizable set of options.
@@ -40,7 +40,6 @@ def home_timeline(options={})
# @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
# @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
# @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
- # @option options [Boolean, String, Integer] :include_rts The timeline will contain native retweets (if they exist) in addition to the standard stream of tweets when set to true, 't' or 1.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
# @return [Array<Twitter::Status>]
# @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
@@ -176,7 +175,7 @@ def retweets_of_me(options={})
# Returns the 20 most recent statuses posted by the specified user
#
# @see https://dev.twitter.com/docs/api/1/get/statuses/user_timeline
- # @note This method can only return up to 3200 statuses. If the :include_rts option is set, only 3200 statuses, including retweets if they exist, can be returned.
+ # @note This method can only return up to 3200 statuses.
# @rate_limited Yes
# @requires_authentication No unless the user whose timeline you're trying to view is protected
# @overload user_timeline(user, options={})
@@ -186,7 +185,6 @@ def retweets_of_me(options={})
# @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
# @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
# @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
- # @option options [Boolean, String, Integer] :include_rts The timeline will contain native retweets (if they exist) in addition to the standard stream of tweets when set to true, 't' or 1.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
# @option options [Boolean, String, Integer] :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.
# @return [Array<Twitter::Status>]
Please sign in to comment.
Something went wrong with that request. Please try again.