Skip to content
Browse files

Fix documentation links [ci skip]

  • Loading branch information...
1 parent 001d915 commit fcd2da33e8364be4ea530c735dca147776496fd7 @sferik committed Dec 8, 2012
Showing with 8 additions and 9 deletions.
  1. +4 −4 lib/twitter/api/places_and_geo.rb
  2. +2 −2 lib/twitter/api/tweets.rb
  3. +2 −3 lib/twitter/api/users.rb
View
8 lib/twitter/api/places_and_geo.rb
@@ -12,7 +12,7 @@ module PlacesAndGeo
# @rate_limited Yes
# @authentication_required Requires user context
# @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @param place_id [String] A place in the world. These IDs can be retrieved from {Twitter::API::Geo#reverse_geocode}.
+ # @param place_id [String] A place in the world. These IDs can be retrieved from {Twitter::API::PlacesAndGeo#reverse_geocode}.
# @param options [Hash] A customizable set of options.
# @return [Twitter::Place] The requested place.
# @example Return all the information about Twitter HQ
@@ -41,7 +41,7 @@ def reverse_geocode(options={})
geo_collection_from_response(:get, "/1.1/geo/reverse_geocode.json", options)
end
- # Search for places that can be attached to a {Twitter::API::Statuses#update}
+ # Search for places that can be attached to a {Twitter::API::Tweets#update}
#
# @see https://dev.twitter.com/docs/api/1.1/get/geo/search
# @rate_limited Yes
@@ -68,7 +68,7 @@ def geo_search(options={})
# Locates places near the given coordinates which are similar in name
#
# @see https://dev.twitter.com/docs/api/1.1/get/geo/similar_places
- # @note Conceptually, you would use this method to get a list of known places to choose from first. Then, if the desired place doesn't exist, make a request to {Twitter::API::Geo#place} to create a new one. The token contained in the response is the token necessary to create a new place.
+ # @note Conceptually, you would use this method to get a list of known places to choose from first. Then, if the desired place doesn't exist, make a request to {Twitter::API::PlacesAndGeo#place} to create a new one. The token contained in the response is the token necessary to create a new place.
# @rate_limited Yes
# @authentication_required Requires user context
# @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
@@ -95,7 +95,7 @@ def similar_places(options={})
# @param options [Hash] A customizable set of options.
# @option options [String] :name The name a place is known as.
# @option options [String] :contained_within This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.
- # @option options [String] :token The token found in the response from {Twitter::API::Geo#places_similar}.
+ # @option options [String] :token The token found in the response from {Twitter::API::PlacesAndGeo#places_similar}.
# @option options [Float] :lat The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
# @option options [Float] :long The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
# @option options [String] :"attribute:street_address" This option searches for places which have this given street address. There are other well-known and application-specific attributes available. Custom attributes are also permitted.
View
4 lib/twitter/api/tweets.rb
@@ -119,7 +119,7 @@ def status_destroy(*args)
# @option options [Integer] :in_reply_to_status_id The ID of an existing status that the update is in reply to.
# @option options [Float] :lat The latitude of the location this tweet refers to. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
# @option options [Float] :long The longitude of the location this tweet refers to. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
- # @option options [String] :place_id A place in the world. These IDs can be retrieved from {Twitter::API::Geo#reverse_geocode}.
+ # @option options [String] :place_id A place in the world. These IDs can be retrieved from {Twitter::API::PlacesAndGeo#reverse_geocode}.
# @option options [String] :display_coordinates Whether or not to put a pin on the exact coordinates a tweet has been sent from.
# @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.
# @example Update the authenticating user's status
@@ -195,7 +195,7 @@ def retweet!(*args)
# @option options [Integer] :in_reply_to_status_id The ID of an existing Tweet that the update is in reply to.
# @option options [Float] :lat The latitude of the location this tweet refers to. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
# @option options [Float] :long The longitude of the location this tweet refers to. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
- # @option options [String] :place_id A place in the world. These IDs can be retrieved from {Twitter::API::Geo#reverse_geocode}.
+ # @option options [String] :place_id A place in the world. These IDs can be retrieved from {Twitter::API::PlacesAndGeo#reverse_geocode}.
# @option options [String] :display_coordinates Whether or not to put a pin on the exact coordinates a tweet has been sent from.
# @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.
# @example Update the authenticating user's status
View
5 lib/twitter/api/users.rb
@@ -248,9 +248,8 @@ def unblock(*args)
# @option options [Symbol, String] :method Requests users via a GET request instead of the standard POST request if set to ':get'.
# @option options [Boolean] :include_entities The tweet entities node will be disincluded when set to false.
# @example Return extended information for @sferik and @pengwynn
- # Twitter.users('sferik', 'pengwynn', :method => :get) # Retrieve users with a GET request
- # Twitter.users(7505382, 14100886, {:method => :get}) # Same as above
- # Twitter.users(7505382, 14100886, {:method => :get, :include_entities => false}) # See Twitter API documentation
+ # Twitter.users('sferik', 'pengwynn', :method => :get) # Retrieve users with a GET request
+ # Twitter.users(7505382, 14100886, :method => :get) # Same as above
def users(*args)
options = extract_options!(args)
method = options.delete(:method) || :post

0 comments on commit fcd2da3

Please sign in to comment.
Something went wrong with that request. Please try again.