Fix documentation

pboling · pboling · commit 8fc879f2a216 · 2016-05-24T22:20:00.000+07:00
diff --git a/lib/dynamoid/finders.rb b/lib/dynamoid/finders.rb
@@ -120,9 +120,11 @@ def find_all_by_composite_key(hash_key, options = {})
       #     field :gender,         :string
       #     field :rank            :number
       #     table :key => :email
-      #     global_secondary_index :hash_key => :age, :range_key => :gender
+      #     global_secondary_index :hash_key => :age, :range_key => :rank
       #   end
-      #   User.find_all_by_secondary_index(:age => 5, :range => {"rank.lte" => 10})
+      #   # NOTE: the first param and the second param are both hashes,
+      #   #       so curly braces must be used on first hash param if sending both params
+      #   User.find_all_by_secondary_index({:age => 5}, :range => {"rank.lte" => 10})
       #
       # @param [Hash] eg: {:age => 5}
       # @param [Hash] eg: {"rank.lte" => 10}
