Permalink
Browse files

Rename @response_formats YARD tag to @response_format for consistency…

… with built-in tags
  • Loading branch information...
1 parent e31b3c5 commit a2869f28d09d9bb116d360167cc6a48c66a45055 @sferik committed Aug 22, 2011
View
@@ -2,7 +2,7 @@
--protected
--tag rate_limited:"Rate Limited?"
--tag requires_authentication:"Requires Authentication?"
---tag response_formats:"Response Formats"
+--tag response_format:"Response Formats"
--markup markdown
-
HISTORY.md
@@ -7,8 +7,8 @@ module Account
# @see https://dev.twitter.com/docs/api/1/get/account/verify_credentials
# @rate_limited Yes
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @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 [Hashie::Mash] The authenticated user.
@@ -27,8 +27,8 @@ def verify_credentials(options={})
# @requires_authentication No
#
# This will return the requesting IP's rate limit status. If you want the authenticating user's rate limit status you must authenticate.
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @return [Hashie::Mash]
# @example Return the remaining number of API requests available to the requesting user
@@ -43,8 +43,8 @@ def rate_limit_status(options={})
# @see https://dev.twitter.com/docs/api/1/post/account/end_session
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @return [Hashie::Mash]
# @example End the session of the authenticating user
@@ -59,8 +59,8 @@ def end_session(options={})
# @see https://dev.twitter.com/docs/api/1/post/account/update_delivery_device
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param device [String] Must be one of: 'sms', 'none'.
# @param options [Hash] A customizable set of options.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
@@ -77,8 +77,8 @@ def update_delivery_device(device, options={})
# @see https://dev.twitter.com/docs/api/1/post/account/update_profile_colors
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @option options [String] :profile_background_color Profile background color.
# @option options [String] :profile_text_color Profile text color.
@@ -100,8 +100,8 @@ def update_profile_colors(options={})
# @note This method asynchronously processes the uploaded file before updating the user's profile image URL. You can either update your local cache the next time you request the user's information, or, at least 5 seconds after uploading the image, ask for the updated URL using {Twitter::Client::User#profile_image}.
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param image [String] The avatar image for the profile. Must be a valid GIF, JPG, or PNG image of less than 700 kilobytes in size. Images with width larger than 500 pixels will be scaled down. Animated GIFs will be converted to a static GIF of the first frame, removing the animation.
# @param options [Hash] A customizable set of options.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
@@ -118,8 +118,8 @@ def update_profile_image(image, options={})
# @see https://dev.twitter.com/docs/api/1/post/account/update_profile_background_image
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param image [String] The background image for the profile. Must be a valid GIF, JPG, or PNG image of less than 800 kilobytes in size. Images with width larger than 2048 pixels will be scaled down.
# @param options [Hash] A customizable set of options.
# @option options [Boolean] :tile Whether or not to tile the background image. If set to true the background image will be displayed tiled. The image will not be tiled otherwise.
@@ -138,8 +138,8 @@ def update_profile_background_image(image, options={})
# @note Only the options specified will be updated.
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @option options [String] :name Full name associated with the profile. Maximum of 20 characters.
# @option options [String] :url URL associated with the profile. Will be prepended with "http://" if not present. Maximum of 100 characters.
@@ -9,8 +9,8 @@ module Block
# @note Destroys a friendship to the blocked user if it exists.
# @rate_limited Yes
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param user [Integer, String] A Twitter user ID or screen name.
# @param options [Hash] A customizable set of options.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
@@ -29,8 +29,8 @@ def block(user, options={})
# @see https://dev.twitter.com/docs/api/1/post/blocks/destroy
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param user [Integer, String] A Twitter user ID or screen name.
# @param options [Hash] A customizable set of options.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
@@ -85,8 +85,8 @@ def block_exists?(user, options={})
# @see https://dev.twitter.com/docs/api/1/get/blocks/blocking
# @rate_limited Yes
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @option options [Integer] :page Specifies the page of results to retrieve.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
@@ -103,8 +103,8 @@ def blocking(options={})
# @see https://dev.twitter.com/docs/api/1/get/blocks/blocking/ids
# @rate_limited Yes
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @return [Array] Numeric user ids the authenticating user is blocking.
# @example Return an array of numeric user ids the authenticating user is blocking
@@ -7,8 +7,8 @@ module DirectMessages
# @see https://dev.twitter.com/docs/api/1/get/direct_messages
# @rate_limited Yes
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
# @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
@@ -28,8 +28,8 @@ def direct_messages(options={})
# @see https://dev.twitter.com/docs/api/1/get/direct_messages/sent
# @rate_limited Yes
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
# @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
@@ -49,8 +49,8 @@ def direct_messages_sent(options={})
# @see https://dev.twitter.com/docs/api/1/post/direct_messages/new
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param user [Integer, String] A Twitter user ID or screen name.
# @param text [String] The text of your direct message, up to 140 characters.
# @param options [Hash] A customizable set of options.
@@ -71,8 +71,8 @@ def direct_message_create(user, text, options={})
# @note The authenticating user must be the recipient of the specified direct message.
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param id [Integer] The ID of the direct message to delete.
# @param options [Hash] A customizable set of options.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
@@ -5,8 +5,8 @@ module Favorites
# @see https://dev.twitter.com/docs/api/1/get/favorites
# @rate_limited Yes
# @requires_authentication No
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @overload favorites(options={})
# Returns the 20 most recent favorite statuses for the authenticating user
#
@@ -37,8 +37,8 @@ def favorites(*args)
# @see https://dev.twitter.com/docs/api/1/post/favorites/create/:id
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param id [Integer] The numerical ID of the desired status.
# @param options [Hash] A customizable set of options.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
@@ -55,8 +55,8 @@ def favorite_create(id, options={})
# @see https://dev.twitter.com/docs/api/1/post/favorites/destroy/:id
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param id [Integer] The numerical ID of the desired status.
# @param options [Hash] A customizable set of options.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
@@ -7,8 +7,8 @@ module FriendsAndFollowers
# @requires_authentication No unless requesting it from a protected user
#
# If getting this data of a protected user, you must authenticate (and be allowed to see that user).
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @overload friend_ids(options={})
# Returns an array of numeric IDs for every user the authenticated user is following
#
@@ -41,8 +41,8 @@ def friend_ids(*args)
# @requires_authentication No unless requesting it from a protected user
#
# If getting this data of a protected user, you must authenticate (and be allowed to see that user).
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @overload follower_ids(options={})
# Returns an array of numeric IDs for every user following the authenticated user
#
@@ -7,8 +7,8 @@ module Friendship
# @see https://dev.twitter.com/docs/api/1/post/friendships/create
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param user [Integer, String] A Twitter user ID or screen name.
# @param options [Hash] A customizable set of options.
# @option options [Boolean] :follow (false) Enable notifications for the target user.
@@ -31,8 +31,8 @@ def follow(user, options={})
# @see https://dev.twitter.com/docs/api/1/post/friendships/destroy
# @rate_limited No
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param user [Integer, String] A Twitter user ID or screen name.
# @param options [Hash] A customizable set of options.
# @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
@@ -52,8 +52,8 @@ def unfollow(user, options={})
# @note Consider using {Twitter::Client::Friendship#friendship} instead of this method.
# @rate_limited Yes
# @requires_authentication No unless user_a or user_b is protected
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param user_a [Integer, String] The ID or screen_name of the subject user.
# @param user_b [Integer, String] The ID or screen_name of the user to test for following.
# @param options [Hash] A customizable set of options.
@@ -71,8 +71,8 @@ def friendship?(user_a, user_b, options={})
# @deprecated {Twitter::Client::Friendship#friendship_exists?} is deprecated and will be removed in the next major version. Please use {Twitter::Client::Friendship#friendship?} instead.
# @rate_limited Yes
# @requires_authentication No unless user_a or user_b is protected
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param user_a [Integer, String] The ID or screen_name of the subject user.
# @param user_b [Integer, String] The ID or screen_name of the user to test for following.
# @param options [Hash] A customizable set of options.
@@ -89,8 +89,8 @@ def friendship_exists?(user_a, user_b, options={})
# @see https://dev.twitter.com/docs/api/1/get/friendships/show
# @rate_limited Yes
# @requires_authentication No
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @option options [Integer] :source_id The ID of the subject user.
# @option options [String] :source_screen_name The screen_name of the subject user.
@@ -110,8 +110,8 @@ def friendship(options={})
# @see https://dev.twitter.com/docs/api/1/get/friendships/incoming
# @rate_limited Yes
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
# @return [Hashie::Mash]
@@ -128,8 +128,8 @@ def friendships_incoming(options={})
# @see https://dev.twitter.com/docs/api/1/get/friendships/outgoing
# @rate_limited Yes
# @requires_authentication Yes
- # @response_formats `json`
- # @response_formats `xml`
+ # @response_format `json`
+ # @response_format `xml`
# @param options [Hash] A customizable set of options.
# @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
# @return [Hashie::Mash]
Oops, something went wrong.

0 comments on commit a2869f2

Please sign in to comment.