lib/mongo/collection/view/change_stream.rb in mongo-2.6.4 vs lib/mongo/collection/view/change_stream.rb in mongo-2.7.0.rc0
- old
+ new
@@ -1,6 +1,6 @@
-# Copyright (C) 2017-2018 MongoDB, Inc.
+# Copyright (C) 2017-2019 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
@@ -16,11 +16,11 @@
module Mongo
class Collection
class View
- # Provides behaviour around a `$changeStream` pipeline stage in the
+ # Provides behavior around a `$changeStream` pipeline stage in the
# aggregation framework. Specifying this stage allows users to request
# that notifications are sent for all changes to a particular collection
# or database.
#
# @note Only available in server versions 3.6 and higher.
@@ -147,10 +147,11 @@
# it will return nil.
#
# @note This method is experimental and subject to change.
#
# @return [ BSON::Document | nil ] A change stream document.
- # @api private
+ # @api experimental
+ # @since 2.6.0
def try_next
raise StopIteration.new if closed?
retried = false
begin