MONGOID-5640 Fix docstring issues (#5677)

comandeo-mongo · web-flow · commit 4381cfdd6a39 · 2023-08-09T12:25:27.000+02:00
diff --git a/lib/mongoid/config/defaults.rb b/lib/mongoid/config/defaults.rb
@@ -11,7 +11,7 @@ module Defaults
       # Note that this method will load the *new* functionality introduced in
       # the given Mongoid version.
       #
-      # @param [ String | Float ] The version number as X.y.
+      # @param [ String | Float ] version The version number as X.y.
       #
       # raises [ ArgumentError ] if an invalid version is given.
       def load_defaults(version)
diff --git a/lib/mongoid/contextual/memory.rb b/lib/mongoid/contextual/memory.rb
@@ -153,7 +153,7 @@ def first(limit = nil)
       #
       # @return [ Document ] The first document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def first!
         first || raise_document_not_found_error
@@ -214,7 +214,7 @@ def last(limit = nil)
       #
       # @return [ Document ] The last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def last!
         last || raise_document_not_found_error
@@ -312,7 +312,7 @@ def take(limit = nil)
       #
       # @return [ Document ] The document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def take!
         take || raise_document_not_found_error
@@ -373,8 +373,6 @@ def update_all(attributes = nil)
       # @example Get the second document.
       #   context.second
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The second document.
       def second
         eager_load([documents.second]).first
@@ -388,7 +386,7 @@ def second
       #
       # @return [ Document ] The second document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def second!
         second || raise_document_not_found_error
@@ -399,8 +397,6 @@ def second!
       # @example Get the third document.
       #   context.third
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The third document.
       def third
         eager_load([documents.third]).first
@@ -414,7 +410,7 @@ def third
       #
       # @return [ Document ] The third document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def third!
         third || raise_document_not_found_error
@@ -425,8 +421,6 @@ def third!
       # @example Get the fourth document.
       #   context.fourth
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The fourth document.
       def fourth
         eager_load([documents.fourth]).first
@@ -440,7 +434,7 @@ def fourth
       #
       # @return [ Document ] The fourth document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def fourth!
         fourth || raise_document_not_found_error
@@ -451,8 +445,6 @@ def fourth!
       # @example Get the fifth document.
       #   context.fifth
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The fifth document.
       def fifth
         eager_load([documents.fifth]).first
@@ -466,7 +458,7 @@ def fifth
       #
       # @return [ Document ] The fifth document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def fifth!
         fifth || raise_document_not_found_error
@@ -477,8 +469,6 @@ def fifth!
       # @example Get the second to last document.
       #   context.second_to_last
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The second to last document.
       def second_to_last
         eager_load([documents.second_to_last]).first
@@ -492,7 +482,7 @@ def second_to_last
       #
       # @return [ Document ] The second to last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def second_to_last!
         second_to_last || raise_document_not_found_error
@@ -503,8 +493,6 @@ def second_to_last!
       # @example Get the third to last document.
       #   context.third_to_last
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The third to last document.
       def third_to_last
         eager_load([documents.third_to_last]).first
@@ -518,7 +506,7 @@ def third_to_last
       #
       # @return [ Document ] The third to last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def third_to_last!
         third_to_last || raise_document_not_found_error
diff --git a/lib/mongoid/contextual/mongo.rb b/lib/mongoid/contextual/mongo.rb
@@ -402,7 +402,7 @@ def take(limit = nil)
       #
       # @return [ Document ] The document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def take!
         # Do to_a first so that the Mongo#first method is not used and the
@@ -584,7 +584,7 @@ def first(limit = nil)
       #
       # @return [ Document ] The first document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def first!
         first || raise_document_not_found_error
@@ -626,7 +626,7 @@ def last(limit = nil)
       #
       # @return [ Document ] The last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def last!
         last || raise_document_not_found_error
@@ -650,7 +650,7 @@ def second
       #
       # @return [ Document ] The second document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def second!
         second || raise_document_not_found_error
@@ -674,7 +674,7 @@ def third
       #
       # @return [ Document ] The third document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def third!
         third || raise_document_not_found_error
@@ -698,7 +698,7 @@ def fourth
       #
       # @return [ Document ] The fourth document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def fourth!
         fourth || raise_document_not_found_error
@@ -722,7 +722,7 @@ def fifth
       #
       # @return [ Document ] The fifth document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def fifth!
         fifth || raise_document_not_found_error
@@ -748,7 +748,7 @@ def second_to_last
       #
       # @return [ Document ] The second to last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def second_to_last!
         second_to_last || raise_document_not_found_error
@@ -774,7 +774,7 @@ def third_to_last
       #
       # @return [ Document ] The third to last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def third_to_last!
         third_to_last || raise_document_not_found_error
diff --git a/lib/mongoid/contextual/mongo/documents_loader.rb b/lib/mongoid/contextual/mongo/documents_loader.rb
@@ -82,9 +82,9 @@ def self.executor(name = Mongoid.async_query_executor)
         # @param [ Class ] klass Mongoid model class to instantiate documents.
         #   All records obtained from the database will be converted to an
         #   instance of this class, if possible.
-        # @param [ Mongoid::Criteria ] criteria. Criteria that specifies which
+        # @param [ Mongoid::Criteria ] criteria Criteria that specifies which
         #   documents should be loaded.
-        # @param [ Concurrent::AbstractExecutorService ] executor. Executor that
+        # @param [ Concurrent::AbstractExecutorService ] executor Executor that
         #   is capable of running `Concurrent::Promises::Future` instances.
         def initialize(view, klass, criteria, executor: self.class.executor)
           @view = view
diff --git a/lib/mongoid/contextual/none.rb b/lib/mongoid/contextual/none.rb
@@ -134,7 +134,7 @@ def first(limit = nil)
       # @example Get the first document in null context.
       #   context.first!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def first!
         raise_document_not_found_error
       end
@@ -156,7 +156,7 @@ def last(limit = nil)
       # @example Get the last document in null context.
       #   context.last!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def last!
         raise_document_not_found_error
       end
@@ -178,7 +178,7 @@ def take(limit = nil)
       # @example Take a document in null context.
       #   context.take!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def take!
         raise_document_not_found_error
       end
@@ -198,7 +198,7 @@ def second
       # @example Get the second document in null context.
       #   context.second!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def second!
         raise_document_not_found_error
       end
@@ -218,7 +218,7 @@ def third
       # @example Get the third document in null context.
       #   context.third!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def third!
         raise_document_not_found_error
       end
@@ -238,7 +238,7 @@ def fourth
       # @example Get the fourth document in null context.
       #   context.fourth!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def fourth!
         raise_document_not_found_error
       end
@@ -258,7 +258,7 @@ def fifth
       # @example Get the fifth document in null context.
       #   context.fifth!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def fifth!
         raise_document_not_found_error
       end
@@ -278,7 +278,7 @@ def second_to_last
       # @example Get the second to last document in null context.
       #   context.second_to_last!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def second_to_last!
         raise_document_not_found_error
       end
@@ -298,7 +298,7 @@ def third_to_last
       # @example Get the third to last document in null context.
       #   context.third_to_last!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def third_to_last!
         raise_document_not_found_error
       end
diff --git a/lib/mongoid/criteria/queryable/storable.rb b/lib/mongoid/criteria/queryable/storable.rb
@@ -83,7 +83,7 @@ def add_field_expression(field, value)
         #
         #     {'$or' => [{'hello' => 'world'}]}
         #
-        # ... and operator is '$or' and op_expr is `[{'test' => 123'}]`,
+        # ... and operator is '$or' and op_expr is +[{'test' => 123'}]+,
         # the resulting selector will be:
         #
         #     {'$or' => [{'hello' => 'world'}, {'test' => 123}]}
@@ -159,7 +159,7 @@ def add_logical_operator_expression(operator, op_expr)
         #
         #     {'foo' => 'bar', '$or' => [{'hello' => 'world'}]}
         #
-        # ... and operator is '$or' and op_expr is `{'test' => 123'}`,
+        # ... and operator is '$or' and op_expr is +{'test' => 123'}+,
         # the resulting selector will be:
         #
         #     {'foo' => 'bar', '$or' => [{'hello' => 'world'}, {'test' => 123}]}
diff --git a/lib/mongoid/deprecation.rb b/lib/mongoid/deprecation.rb
@@ -14,7 +14,7 @@ class Deprecation < ::ActiveSupport::Deprecation
     # Overrides default ActiveSupport::Deprecation behavior
     # to use Mongoid's logger.
     #
-    # @return Array<Proc> The deprecation behavior.
+    # @return [ Array<Proc> ] The deprecation behavior.
     def behavior
       @behavior ||= Array(->(message, callstack, _deprecation_horizon, _gem_name) {
         logger = Mongoid.logger
diff --git a/lib/mongoid/document.rb b/lib/mongoid/document.rb
@@ -185,7 +185,7 @@ def becomes(klass)
     # Sets the internal state of this document. Used only by #becomes to
     # help initialize a retyped document.
     #
-    # @params state [ Hash ] The map of internal state values.
+    # @param [ Hash ] state The map of internal state values.
     #
     # @api private
     def internal_state=(state)
@@ -354,7 +354,7 @@ def update_discriminator(key_was)
 
     # Marks all embedded documents with the given "new_record" state.
     #
-    # @params new_record [ true | false ] whether or not the embedded records
+    # @param [ true | false ] new_record  whether or not the embedded records
     #   should be flagged as new records or not.
     def mark_persisted_state_for_embedded_documents(new_record)
       embedded_relations.each_pair do |name, _meta|
@@ -369,7 +369,7 @@ def mark_persisted_state_for_embedded_documents(new_record)
 
     # Either executes or enqueues the post-construction callbacks.
     #
-    # @params execute_callbacks [ true | false ] whether the callbacks
+    # @param [ true | false ] execute_callbacks whether the callbacks
     #   should be executed (true) or enqueued (false)
     def resolve_post_construction_callbacks(execute_callbacks)
       if execute_callbacks
@@ -387,7 +387,7 @@ module ClassMethods
       # within the block. Callbacks may always be explicitly invoked by passing
       # `execute_callbacks: true` where available.
       #
-      # @params execute_callbacks [ true | false ] Whether callbacks should be
+      # @param [ true | false ] execute_callbacks Whether callbacks should be
       #   suppressed or not.
       def with_callbacks(execute_callbacks)
         saved, Threaded.execute_callbacks =
@@ -406,8 +406,6 @@ def with_callbacks(execute_callbacks)
       # @param [ Hash ] attrs The hash of attributes to instantiate with.
       # @param [ Integer ] selected_fields The selected fields from the
       #   criteria.
-      # @param [ true | false ] execute_callbacks Flag specifies whether callbacks
-      #   should be run.
       #
       # @return [ Document ] A new document.
       def instantiate(attrs = nil, selected_fields = nil, &block)
diff --git a/lib/mongoid/factory.rb b/lib/mongoid/factory.rb
diff --git a/lib/mongoid/fields.rb b/lib/mongoid/fields.rb

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ module Defaults`
`11`	`11`	`# Note that this method will load the new functionality introduced in`
`12`	`12`	`# the given Mongoid version.`
`13`	`13`	`#`
`14`		`- # @param [ String \| Float ] The version number as X.y.`
	`14`	`+ # @param [ String \| Float ] version The version number as X.y.`
`15`	`15`	`#`
`16`	`16`	`# raises [ ArgumentError ] if an invalid version is given.`
`17`	`17`	`def load_defaults(version)`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ def first(limit = nil)`
`153`	`153`	`#`
`154`	`154`	`# @return [ Document ] The first document.`
`155`	`155`	`#`
`156`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`156`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`157`	`157`	`# documents to take.`
`158`	`158`	`def first!`
`159`	`159`	`first \|\| raise_document_not_found_error`
`@@ -214,7 +214,7 @@ def last(limit = nil)`
`214`	`214`	`#`
`215`	`215`	`# @return [ Document ] The last document.`
`216`	`216`	`#`
`217`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`217`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`218`	`218`	`# documents to take.`
`219`	`219`	`def last!`
`220`	`220`	`last \|\| raise_document_not_found_error`
`@@ -312,7 +312,7 @@ def take(limit = nil)`
`312`	`312`	`#`
`313`	`313`	`# @return [ Document ] The document.`
`314`	`314`	`#`
`315`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`315`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`316`	`316`	`# documents to take.`
`317`	`317`	`def take!`
`318`	`318`	`take \|\| raise_document_not_found_error`
`@@ -373,8 +373,6 @@ def update_all(attributes = nil)`
`373`	`373`	`# @example Get the second document.`
`374`	`374`	`# context.second`
`375`	`375`	`#`
`376`		`- # @param [ Integer ] limit The number of documents to return.`
`377`		`- #`
`378`	`376`	`# @return [ Document ] The second document.`
`379`	`377`	`def second`
`380`	`378`	`eager_load([documents.second]).first`
`@@ -388,7 +386,7 @@ def second`
`388`	`386`	`#`
`389`	`387`	`# @return [ Document ] The second document.`
`390`	`388`	`#`
`391`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`389`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`392`	`390`	`# documents to take.`
`393`	`391`	`def second!`
`394`	`392`	`second \|\| raise_document_not_found_error`
`@@ -399,8 +397,6 @@ def second!`
`399`	`397`	`# @example Get the third document.`
`400`	`398`	`# context.third`
`401`	`399`	`#`
`402`		`- # @param [ Integer ] limit The number of documents to return.`
`403`		`- #`
`404`	`400`	`# @return [ Document ] The third document.`
`405`	`401`	`def third`
`406`	`402`	`eager_load([documents.third]).first`
`@@ -414,7 +410,7 @@ def third`
`414`	`410`	`#`
`415`	`411`	`# @return [ Document ] The third document.`
`416`	`412`	`#`
`417`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`413`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`418`	`414`	`# documents to take.`
`419`	`415`	`def third!`
`420`	`416`	`third \|\| raise_document_not_found_error`
`@@ -425,8 +421,6 @@ def third!`
`425`	`421`	`# @example Get the fourth document.`
`426`	`422`	`# context.fourth`
`427`	`423`	`#`
`428`		`- # @param [ Integer ] limit The number of documents to return.`
`429`		`- #`
`430`	`424`	`# @return [ Document ] The fourth document.`
`431`	`425`	`def fourth`
`432`	`426`	`eager_load([documents.fourth]).first`
`@@ -440,7 +434,7 @@ def fourth`
`440`	`434`	`#`
`441`	`435`	`# @return [ Document ] The fourth document.`
`442`	`436`	`#`
`443`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`437`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`444`	`438`	`# documents to take.`
`445`	`439`	`def fourth!`
`446`	`440`	`fourth \|\| raise_document_not_found_error`
`@@ -451,8 +445,6 @@ def fourth!`
`451`	`445`	`# @example Get the fifth document.`
`452`	`446`	`# context.fifth`
`453`	`447`	`#`
`454`		`- # @param [ Integer ] limit The number of documents to return.`
`455`		`- #`
`456`	`448`	`# @return [ Document ] The fifth document.`
`457`	`449`	`def fifth`
`458`	`450`	`eager_load([documents.fifth]).first`
`@@ -466,7 +458,7 @@ def fifth`
`466`	`458`	`#`
`467`	`459`	`# @return [ Document ] The fifth document.`
`468`	`460`	`#`
`469`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`461`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`470`	`462`	`# documents to take.`
`471`	`463`	`def fifth!`
`472`	`464`	`fifth \|\| raise_document_not_found_error`
`@@ -477,8 +469,6 @@ def fifth!`
`477`	`469`	`# @example Get the second to last document.`
`478`	`470`	`# context.second_to_last`
`479`	`471`	`#`
`480`		`- # @param [ Integer ] limit The number of documents to return.`
`481`		`- #`
`482`	`472`	`# @return [ Document ] The second to last document.`
`483`	`473`	`def second_to_last`
`484`	`474`	`eager_load([documents.second_to_last]).first`
`@@ -492,7 +482,7 @@ def second_to_last`
`492`	`482`	`#`
`493`	`483`	`# @return [ Document ] The second to last document.`
`494`	`484`	`#`
`495`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`485`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`496`	`486`	`# documents to take.`
`497`	`487`	`def second_to_last!`
`498`	`488`	`second_to_last \|\| raise_document_not_found_error`
`@@ -503,8 +493,6 @@ def second_to_last!`
`503`	`493`	`# @example Get the third to last document.`
`504`	`494`	`# context.third_to_last`
`505`	`495`	`#`
`506`		`- # @param [ Integer ] limit The number of documents to return.`
`507`		`- #`
`508`	`496`	`# @return [ Document ] The third to last document.`
`509`	`497`	`def third_to_last`
`510`	`498`	`eager_load([documents.third_to_last]).first`
`@@ -518,7 +506,7 @@ def third_to_last`
`518`	`506`	`#`
`519`	`507`	`# @return [ Document ] The third to last document.`
`520`	`508`	`#`
`521`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`509`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`522`	`510`	`# documents to take.`
`523`	`511`	`def third_to_last!`
`524`	`512`	`third_to_last \|\| raise_document_not_found_error`
Original file line number	Diff line number	Diff line change
`@@ -402,7 +402,7 @@ def take(limit = nil)`
`402`	`402`	`#`
`403`	`403`	`# @return [ Document ] The document.`
`404`	`404`	`#`
`405`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`405`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`406`	`406`	`# documents to take.`
`407`	`407`	`def take!`
`408`	`408`	`# Do to_a first so that the Mongo#first method is not used and the`
`@@ -584,7 +584,7 @@ def first(limit = nil)`
`584`	`584`	`#`
`585`	`585`	`# @return [ Document ] The first document.`
`586`	`586`	`#`
`587`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`587`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`588`	`588`	`# documents available.`
`589`	`589`	`def first!`
`590`	`590`	`first \|\| raise_document_not_found_error`
`@@ -626,7 +626,7 @@ def last(limit = nil)`
`626`	`626`	`#`
`627`	`627`	`# @return [ Document ] The last document.`
`628`	`628`	`#`
`629`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`629`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`630`	`630`	`# documents available.`
`631`	`631`	`def last!`
`632`	`632`	`last \|\| raise_document_not_found_error`
`@@ -650,7 +650,7 @@ def second`
`650`	`650`	`#`
`651`	`651`	`# @return [ Document ] The second document.`
`652`	`652`	`#`
`653`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`653`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`654`	`654`	`# documents available.`
`655`	`655`	`def second!`
`656`	`656`	`second \|\| raise_document_not_found_error`
`@@ -674,7 +674,7 @@ def third`
`674`	`674`	`#`
`675`	`675`	`# @return [ Document ] The third document.`
`676`	`676`	`#`
`677`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`677`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`678`	`678`	`# documents available.`
`679`	`679`	`def third!`
`680`	`680`	`third \|\| raise_document_not_found_error`
`@@ -698,7 +698,7 @@ def fourth`
`698`	`698`	`#`
`699`	`699`	`# @return [ Document ] The fourth document.`
`700`	`700`	`#`
`701`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`701`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`702`	`702`	`# documents available.`
`703`	`703`	`def fourth!`
`704`	`704`	`fourth \|\| raise_document_not_found_error`
`@@ -722,7 +722,7 @@ def fifth`
`722`	`722`	`#`
`723`	`723`	`# @return [ Document ] The fifth document.`
`724`	`724`	`#`
`725`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`725`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`726`	`726`	`# documents available.`
`727`	`727`	`def fifth!`
`728`	`728`	`fifth \|\| raise_document_not_found_error`
`@@ -748,7 +748,7 @@ def second_to_last`
`748`	`748`	`#`
`749`	`749`	`# @return [ Document ] The second to last document.`
`750`	`750`	`#`
`751`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`751`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`752`	`752`	`# documents available.`
`753`	`753`	`def second_to_last!`
`754`	`754`	`second_to_last \|\| raise_document_not_found_error`
`@@ -774,7 +774,7 @@ def third_to_last`
`774`	`774`	`#`
`775`	`775`	`# @return [ Document ] The third to last document.`
`776`	`776`	`#`
`777`		`- # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
	`777`	`+ # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no`
`778`	`778`	`# documents available.`
`779`	`779`	`def third_to_last!`
`780`	`780`	`third_to_last \|\| raise_document_not_found_error`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ def add_field_expression(field, value)`
`83`	`83`	`#`
`84`	`84`	`# {'$or' => [{'hello' => 'world'}]}`
`85`	`85`	`#`
`86`		- # ... and operator is '$or' and op_expr is `[{'test' => 123'}]`,
	`86`	`+ # ... and operator is '$or' and op_expr is +[{'test' => 123'}]+,`
`87`	`87`	`# the resulting selector will be:`
`88`	`88`	`#`
`89`	`89`	`# {'$or' => [{'hello' => 'world'}, {'test' => 123}]}`
`@@ -159,7 +159,7 @@ def add_logical_operator_expression(operator, op_expr)`
`159`	`159`	`#`
`160`	`160`	`# {'foo' => 'bar', '$or' => [{'hello' => 'world'}]}`
`161`	`161`	`#`
`162`		- # ... and operator is '$or' and op_expr is `{'test' => 123'}`,
	`162`	`+ # ... and operator is '$or' and op_expr is +{'test' => 123'}+,`
`163`	`163`	`# the resulting selector will be:`
`164`	`164`	`#`
`165`	`165`	`# {'foo' => 'bar', '$or' => [{'hello' => 'world'}, {'test' => 123}]}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ class Deprecation < ::ActiveSupport::Deprecation`
`14`	`14`	`# Overrides default ActiveSupport::Deprecation behavior`
`15`	`15`	`# to use Mongoid's logger.`
`16`	`16`	`#`
`17`		`- # @return Array<Proc> The deprecation behavior.`
	`17`	`+ # @return [ Array<Proc> ] The deprecation behavior.`
`18`	`18`	`def behavior`
`19`	`19`	`@behavior \|\|= Array(->(message, callstack, _deprecation_horizon, _gem_name) {`
`20`	`20`	`logger = Mongoid.logger`