client.rb in peddler-1.3.0

- old
+ new

@@ -14,18 +14,18 @@
     #   checkout options, cart information is returned only for Seller-Branded
     #   Checkout accounts.
     # @note In addition to registering for Amazon MWS, you must also request
     #   authorization to use the Cart Information API section.
     class Client < ::Peddler::Client
-      version "2014-03-01"
+      version '2014-03-01'
       path "/CartInformation/#{version}"
 
       # Lists shopping carts
       #
       # @see http://docs.developer.amazonservices.com/en_US/cart_info/CartInfo_ListCarts.html
-      # @param date_range_start [String, #iso8601]
-      # @param opts [Hash]
+      # @param [String, #iso8601] date_range_start
+      # @param [Hash] opts
       # @option opts [String] :marketplace_id
       # @option opts [String, #iso8601] :date_range_end
       # @return [Peddler::XMLParser]
       def list_carts(date_range_start, opts = {})
         operation('ListCarts')
@@ -35,11 +35,11 @@
       end
 
       # Lists the next page of shopping carts
       #
       # @see http://docs.developer.amazonservices.com/en_US/cart_info/CartInfo_ListCartsByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_carts_by_next_token(next_token)
         operation('ListCartsByNextToken')
           .add('NextToken' => next_token)
 
@@ -47,11 +47,12 @@
       end
 
       # Returns shopping carts based on specified values
       #
       # @see http://docs.developer.amazonservices.com/en_US/cart_info/CartInfo_GetCarts.html
-      # @param marketplace_id [String]
-      # @param cart_id_list [Array<String>]
+      # @overload get_carts(marketplace_id, *cart_ids)
+      #   @param [String] marketplace_id
+      #   @param [String] cart_id one or more cart_ids
       # @return [Peddler::XMLParser]
       def get_carts(marketplace_id, *cart_id_list)
         operation('GetCarts')
           .add('MarketplaceId' => marketplace_id, 'CartIdList' => cart_id_list)
           .structure!('CartIdList', 'CartId')