lib/google/cloud/logging/sink/list.rb in google-cloud-logging-0.24.2 vs lib/google/cloud/logging/sink/list.rb in google-cloud-logging-1.0.0

@@ -73,18 +73,18 @@
             list_grpc = @service.list_sinks token: token, max: @max
             self.class.from_grpc list_grpc, @service
           end
 
           ##
-          # Retrieves all sinks by repeatedly loading {#next} until {#next?}
-          # returns `false`. Calls the given block once for each sink, which is
-          # passed as the parameter.
+          # Retrieves remaining results by repeatedly invoking {#next} until
+          # {#next?} returns `false`. Calls the given block once for each
+          # result, which is passed as the argument to the block.
           #
           # An Enumerator is returned if no block is given.
           #
-          # This method may make several API calls until all sinks are
-          # retrieved. Be sure to use as narrow a search criteria as possible.
-          # Please use with caution.
+          # This method will make repeated API calls until all remaining results
+          # are retrieved. (Unlike `#each`, for example, which merely iterates
+          # over the results returned by a single API call.) Use with caution.
           #
           # @param [Integer] request_limit The upper limit of API requests to
           #   make to load all sinks. Default is no limit.
           # @yield [sink] The block for accessing each sink.
           # @yieldparam [Sink] sink The sink object.