rows_reader.rb in google-cloud-bigtable-0.2.0

- old
+ new

@@ -43,11 +43,11 @@
         # @return [Integer] Current retry count
         attr_accessor :retry_count
 
         # @private
         #
-        # Create read rows instance
+        # Creates a read rows instance.
         #
         # @param table [Google::Cloud::Bigtable::TableDataOperations]
         #
         def initialize table
           @table = table
@@ -59,16 +59,15 @@
         # Read rows
         #
         # @param rows [Google::Bigtable::V2::RowSet]
         #   The row keys and/or ranges to read.
         #   If not specified, reads from all rows.
-        #   A hash of the same form as `Google::Bigtable::V2::RowSet`
-        #   can also be provided.
+        #   Alternatively, provide a hash in the form of `Google::Bigtable::V2::RowSet`.
         # @param filter [Google::Bigtable::V2::RowFilter | Hash]
         #   The filter to apply to the contents of the specified row(s). If unset,
         #   reads the entirety of each row.
-        #   A hash of the same form as `Google::Bigtable::V2::RowFilter`
+        #   A hash in the form of `Google::Bigtable::V2::RowFilter`
         #   can also be provided.
         # @param rows_limit [Integer]
         #   The read will terminate after committing to N rows' worth of results.
         #   The default (zero) is to return all results.
         # @return [:yields: row]
@@ -96,19 +95,19 @@
           end
 
           @chunk_processor.validate_last_row_complete
         end
 
-        # Last read row key
+        # Last read row key.
         #
         # @return [String]
 
         def last_key
           @chunk_processor.last_key
         end
 
-        # Calucate and return read rows limit and row set based on last read key
+        # Calucates and returns the read rows limit and row set based on last read key.
         #
         # @param rows_limit [Integer]
         #   The read will terminate after committing to N rows' worth of results.
         #   The default (zero) is to return all results.
         # @param row_set [Google::Bigtable::V2::RowSet]
@@ -150,20 +149,20 @@
 
           @chunk_processor.reset_to_new_row
           [rows_limit, row_set]
         end
 
-        # Check if read operation is retryable.
+        # Checks if a read operation is retryable.
         #
         # @return [Boolean]
         def retryable?
           @retry_count < RowsReader::RETRY_LIMIT
         end
 
         private
 
-        # Check start key already read for range
+        # Checks if the start key was already read for the range.
         #
         # @param range [Google::Bigtable::V2::RowRange]
         # @return [Boolean]
         #
         def start_key_read? range
@@ -174,10 +173,10 @@
                       end
 
           start_key.empty? || last_key >= start_key
         end
 
-        # Check end key already read for range
+        # Checks if the end key was already read for the range.
         #
         # @param range [Google::Bigtable::V2::RowRange]
         # @return [Boolean]
         #
         def end_key_read? range