Polish and reword comments

Author: andrykonchin

lib/dynamoid/persistence.rb

@@ -325,6 +325,8 @@ def update!(hash_key, range_key_value = nil, attrs)
       # @param range_key_value [Scalar value] range key (optional)
       # @param attrs [Hash]
       # @param conditions [Hash] (optional)
+      # @option conditions [Hash] :if conditions on attribute values
+      # @option conditions [Hash] :unless_exists conditions on attributes presence
       # @return [Dynamoid::Document|nil] Updated document
       def update_fields(hash_key_value, range_key_value = nil, attrs = {}, conditions = {})
         optional_params = [range_key_value, attrs, conditions].compact
@@ -387,6 +389,8 @@ def update_fields(hash_key_value, range_key_value = nil, attrs = {}, conditions
       # @param range_key_value [Scalar value] range key (optional)
       # @param attrs [Hash]
       # @param conditions [Hash] (optional)
+      # @option conditions [Hash] :if conditions on attribute values
+      # @option conditions [Hash] :unless_exists conditions on attributes presence
       # @return [Dynamoid::Document|nil] Updated document
       def upsert(hash_key_value, range_key_value = nil, attrs = {}, conditions = {})
         optional_params = [range_key_value, attrs, conditions].compact
@@ -533,7 +537,8 @@ def persisted?
     # If a model is new and hash key (+id+ by default) is not assigned yet
     # it was assigned implicitly with random UUID value.
     #
-    # If +lock_version+ attribute is declared it will be incremented. If it's blank then it will be initialized with 1.
+    # If +lock_version+ attribute is declared it will be incremented. If it's
+    # blank then it will be initialized with 1.
     #
     # +save+ method call raises +Dynamoid::Errors::RecordNotUnique+ exception
     # if primary key (hash key + optional range key) already exists in a

lib/dynamoid/persistence/save.rb

@@ -12,7 +12,7 @@ def self.call(model, **options)
 
       def initialize(model, touch: nil)
         @model = model
-        @touch = touch # touch=false means explicit disabling of updating the `updated_at` attribute
+        @touch = touch # `touch: false` means explicit disabling of updating the `updated_at` attribute
       end
 
       def call

lib/dynamoid/transaction_read.rb

@@ -96,8 +96,9 @@ def commit
     #
     # Please note that there are the following differences between
     # transactional and non-transactional +find+:
-    # - transactional +find+ preserves order of models in result when multiple ids are given
-    # - transactional +find+ doesn't return results immediately, a single collection with results of all the +find+ calls is returned instead
+    # - transactional +find+ preserves order of models in result when given multiple ids
+    # - transactional +find+ doesn't return results immediately, a single
+    #   collection with results of all the +find+ calls is returned instead
     # - +:consistent_read+ option isn't supported
     # - transactional +find+ is subject to limitations of the
     #   [TransactGetItems](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html)
@@ -106,7 +107,7 @@ def commit
     # @param [Object|Array] ids a single primary key or an array of primary keys
     # @param [Hash] options optional parameters of the operation
     # @option options [Object] :range_key sort key of a model; required when a single partition key is given and a sort key is declared for a model
-    # @option options [true|false] :raise_key whether to raise a RecordNotFound exception; specify explicitly +raise: false+ to suppress the exception; default is true
+    # @option options [true|false] :raise_error whether to raise a +RecordNotFound+ exception; specify explicitly +raise_error: false+ to suppress the exception; default is +true+
     # @return [nil]
     #
     # @example Find by partition key