Permalink
Browse files

Updating documentation, removing specific limits.

- Refer to documentation for all counts and limits
http://instagram.com/developer/
  • Loading branch information...
1 parent 5e29122 commit 2a5770b1fed42c44a56127ca575c101f64740931 @shayne shayne committed May 9, 2011
@@ -24,7 +24,7 @@ def location(id, *args)
# @param user [Integer] An Instagram user ID.
# @param options [Hash] A customizable set of options.
# @option options [Integer] :max_id (nil) Returns results with an ID less than (that is, older than) or equal to the specified ID.
- # @option options [Integer] :count (nil) Limits the number of results returned per page, maximum 150.
+ # @option options [Integer] :count (nil) Limits the number of results returned per page.
# @return [Hashie::Mash]
# @example Return a list of the most recent media items taken at the Instagram office
# Instagram.location_recent_media(514276)
@@ -42,7 +42,7 @@ def location_recent_media(id, *args)
#
# @param lat [String] A given latitude in decimal format
# @param lng [String] A given longitude in decimal format
- # @option options [Integer] :count The number of media items to retrieve. Maxiumum of 100 allowed per page.
+ # @option options [Integer] :count The number of media items to retrieve.
# @return [Array]
# @example Return locations around 37.7808851, -122.3948632 (164 S Park, SF, CA USA)
# Instagram.location_search("37.7808851", "-122.3948632")
@@ -46,7 +46,7 @@ def media_popular(*args)
# @param lat [String] A given latitude in decimal format
# @param lng [String] A given longitude in decimal format
# @param options [Hash] A customizable set of options.
- # @option options [Integer] :count The number of media items to retrieve. Maxiumum of 100 allowed per page.
+ # @option options [Integer] :count The number of media items to retrieve.
# @return [Array]
# @example Return media around 37.7808851, -122.3948632 (164 S Park, SF, CA USA)
# Instagram.media_search("37.7808851", "-122.3948632")
@@ -31,7 +31,7 @@ def subscriptions(options={})
# @option options [String, Integer] :object_id When specifying a location or tag use the location's ID or tag name respectively
# @option options [String, Float] :lat The center latitude of an area, used when subscribing to a geography object
# @option options [String, Float] :lng The center longitude of an area, used when subscribing to a geography object
- # @option options [String, Integer] :radius The distance in meters you'd like to capture around a given point (max 5000 meters)
+ # @option options [String, Integer] :radius The distance in meters you'd like to capture around a given point
# @overload create_subscription(object, callback_url, aspect="media", options={})
# @param object [String] The object you'd like to subscribe to (user, tag, location or geography)
# @param callback_url [String] The subscription callback URL
@@ -40,7 +40,7 @@ def subscriptions(options={})
# @option options [String, Integer] :object_id When specifying a location or tag use the location's ID or tag name respectively
# @option options [String, Float] :lat The center latitude of an area, used when subscribing to a geography object
# @option options [String, Float] :lng The center longitude of an area, used when subscribing to a geography object
- # @option options [String, Integer] :radius The distance in meters you'd like to capture around a given point (max 5000 meters)
+ # @option options [String, Integer] :radius The distance in meters you'd like to capture around a given point
#
# Note that we only support "media" at this time, but we might support other types of subscriptions in the future.
# @return [Hashie::Mash] The subscription created.
@@ -24,7 +24,7 @@ def tag(tag, *args)
# @param user [String] An Instagram tag name.
# @param options [Hash] A customizable set of options.
# @option options [Integer] :max_id (nil) Returns results with an ID less than (that is, older than) or equal to the specified ID.
- # @option options [Integer] :count (nil) Limits the number of results returned per page, maximum 150.
+ # @option options [Integer] :count (nil) Limits the number of results returned per page.
# @return [Hashie::Mash]
# @example Return a list of the most recent media items tagged "cat"
# Instagram.tag_recent_media('cat')
@@ -45,7 +45,7 @@ def tag_recent_media(id, *args)
# @rate_limited true
# @param query [String] The beginning or complete tag name to search for
# @param options [Hash] A customizable set of options.
- # @option options [Integer] :count The number of media items to retrieve. Maxiumum of 100 allowed per page.
+ # @option options [Integer] :count The number of media items to retrieve.
# @return [Array]
# @see TODO:doc url
# @example Return tags that start with "cat"
@@ -28,7 +28,7 @@ def user(*args)
# @rate_limited true
# @param query [String] The search query to run against user search.
# @param options [Hash] A customizable set of options.
- # @option options [Integer] :count The number of users to retrieve. Maxiumum of 100 allowed per page.
+ # @option options [Integer] :count The number of users to retrieve.
# @return [Array]
# @see TODO:doc url
# @example Return users that match "Shayne Sweeney"
@@ -49,7 +49,7 @@ def user_search(query, options={})
# @param user [Integer] An Instagram user ID.
# @param options [Hash] A customizable set of options.
# @option options [Integer] :cursor (nil) Breaks the results into pages. Provide values as returned in the response objects's next_cursor attribute to page forward in the list.
- # @option options [Integer] :count (nil) Limits the number of results returned per page, maximum 150.
+ # @option options [Integer] :count (nil) Limits the number of results returned per page.
# @return [Hashie::Mash]
# @example Return a list of users @mikeyk follows
# Instagram.user_follows(4) # @mikeyk user ID being 4
@@ -78,7 +78,7 @@ def user_follows(*args)
# @param user [Integer] An Instagram user ID.
# @param options [Hash] A customizable set of options.
# @option options [Integer] :cursor (nil) Breaks the results into pages. Provide values as returned in the response objects's next_cursor attribute to page forward in the list.
- # @option options [Integer] :count (nil) Limits the number of results returned per page, maximum 150.
+ # @option options [Integer] :count (nil) Limits the number of results returned per page.
# @return [Hashie::Mash]
# @example Return a list of users @mikeyk is followed by
# Instagram.user_followed_by(4) # @mikeyk user ID being 4
@@ -115,14 +115,14 @@ def user_requested_by()
response["data"]
end
- # Returns the 20 most recent media items from the currently authorized user's feed.
+ # Returns most recent media items from the currently authorized user's feed.
#
# @overload user_media_feed(options={})
# @param options [Hash] A customizable set of 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, per page. Must be less than or equal to 100.
+ # @option options [Integer] :count Specifies the number of records to retrieve, per page.
# @return [Array]
- # @example Return the 20 most recent media images that would appear on @shayne's feed
+ # @example Return most recent media images that would appear on @shayne's feed
# Instagram.user_media_feed() # assuming @shayne is the authorized user
# @format :json
# @authenticated true
@@ -145,7 +145,7 @@ def user_media_feed(*args)
# @param user [Integer] An Instagram user ID.
# @param options [Hash] A customizable set of options.
# @option options [Integer] :max_id (nil) Returns results with an ID less than (that is, older than) or equal to the specified ID.
- # @option options [Integer] :count (nil) Limits the number of results returned per page, maximum 150.
+ # @option options [Integer] :count (nil) Limits the number of results returned per page.
# @return [Hashie::Mash]
# @example Return a list of media items taken by @mikeyk
# Instagram.user_recent_media(4) # @mikeyk user ID being 4

0 comments on commit 2a5770b

Please sign in to comment.