users.rb in twitter-4.4.1

- old
+ new

@@ -156,13 +156,14 @@
       # @see https://dev.twitter.com/docs/api/1.1/get/blocks/ids
       # @rate_limited Yes
       # @authentication_required Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array] Numeric user ids the authenticating user is blocking.
-      # @param options [Hash] A customizable set of options.
       # @example Return an array of numeric user ids the authenticating user is blocking
       #   Twitter.blocking_ids
+      # @overload block(options={})
+      #   @param options [Hash] A customizable set of options.
       def blocked_ids(*args)
         ids_from_response(:get, "/1.1/blocks/ids.json", args)
       end
 
       # Returns true if the authenticating user is blocking a target user
@@ -245,13 +246,12 @@
       #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
       #   @param options [Hash] A customizable set of options.
       #   @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
         args.flatten.each_slice(MAX_USERS_PER_REQUEST).threaded_map do |users|
           collection_from_response(Twitter::User, method, "/1.1/users/lookup.json", merge_users(options, users))
@@ -392,10 +392,10 @@
       # @authentication_required Requires user context
       # @raise [Twitter::Error::BadRequest] Error raised when either an image was not provided or the image data could not be processed.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @raise [Twitter::Error::UnprocessableEntity] Error raised when the image could not be resized or is too large.
       # @return [nil]
-      # @param image [File] The Base64-encoded or raw image data being uploaded as the user's new profile banner.
+      # @param banner [File] The Base64-encoded or raw image data being uploaded as the user's new profile banner.
       # @param options [Hash] A customizable set of options.
       # @option options [Integer] :width The width of the preferred section of the image being uploaded in pixels. Use with height, offset_left, and offset_top to select the desired region of the image to use.
       # @option options [Integer] :height The height of the preferred section of the image being uploaded in pixels. Use with width, offset_left, and offset_top to select the desired region of the image to use.
       # @option options [Integer] :offset_left The number of pixels by which to offset the uploaded image from the left. Use with height, width, and offset_top to select the desired region of the image to use.
       # @option options [Integer] :offset_top The number of pixels by which to offset the uploaded image from the top. Use with height, width, and offset_left to select the desired region of the image to use.