mongoid 8.0.1 → 8.0.2

data/lib/mongoid/extensions/module.rb

@@ -12,7 +12,7 @@ module Mongoid
       #     self
       #   end
       #
-      # @param [ String, Symbol ] name The name of the method.
+      # @param [ String | Symbol ] name The name of the method.
       # @param [ Proc ] block The method body.
       #
       # @return [ Method ] The new method.

data/lib/mongoid/extensions/object.rb

@@ -90,10 +90,10 @@ module Mongoid
       # @example Do or do not.
       #   object.do_or_do_not(:use, "The Force")
       #
-      # @param [ String, Symbol ] name The method name.
+      # @param [ String | Symbol ] name The method name.
       # @param [ Array ] args The arguments.
       #
-      # @return [ Object, nil ] The result of the method call or nil if the
+      # @return [ Object | nil ] The result of the method call or nil if the
       #   method does not exist.
       def do_or_do_not(name, *args)
         send(name, *args) if name && respond_to?(name)
@@ -106,7 +106,7 @@ module Mongoid
       #
       # @param [ String ] name The name of the variable.
       #
-      # @return [ Object, false ] The value or false.
+      # @return [ Object | false ] The value or false.
       def ivar(name)
         var_name = "@_#{name}"
         if instance_variable_defined?(var_name)
@@ -154,7 +154,7 @@ module Mongoid
       #
       # @param [ String ] name The name of the variable.
       #
-      # @return [ true, false ] If the variable was defined.
+      # @return [ true | false ] If the variable was defined.
       def remove_ivar(name)
         if instance_variable_defined?("@_#{name}")
           return remove_instance_variable("@_#{name}")
@@ -189,10 +189,10 @@ module Mongoid
       # @example You must perform this execution.
       #   object.you_must(:use, "The Force")
       #
-      # @param [ String, Symbol ] name The method name.
+      # @param [ String | Symbol ] name The method name.
       # @param [ Array ] args The arguments.
       #
-      # @return [ Object, nil ] The result of the method call or nil if the
+      # @return [ Object | nil ] The result of the method call or nil if the
       #   method does not exist. Nil if the object is frozen.
       def you_must(name, *args)
         frozen? ? nil : do_or_do_not(name, *args)

data/lib/mongoid/extensions/string.rb

@@ -12,7 +12,7 @@ module Mongoid
       # @example Evolve the string.
       #   "test".__evolve_object_id__
       #
-      # @return [ String, BSON::ObjectId ] The evolved string.
+      # @return [ String | BSON::ObjectId ] The evolved string.
       def __evolve_object_id__
         convert_to_object_id
       end
@@ -22,7 +22,7 @@ module Mongoid
       # @example Evolve the string.
       #   "test".__mongoize_object_id__
       #
-      # @return [ String, BSON::ObjectId, nil ] The mongoized string.
+      # @return [ String | BSON::ObjectId | nil ] The mongoized string.
       def __mongoize_object_id__
         convert_to_object_id unless blank?
       end
@@ -65,7 +65,7 @@ module Mongoid
       # @example Is the string an id value?
       #   "_id".mongoid_id?
       #
-      # @return [ true, false ] If the string is id or _id.
+      # @return [ true | false ] If the string is id or _id.
       def mongoid_id?
         self =~ /\A(|_)id\z/
       end
@@ -76,7 +76,7 @@ module Mongoid
       # @example Is the string a number.
       #   "1234.23".numeric?
       #
-      # @return [ true, false ] If the string is a number.
+      # @return [ true | false ] If the string is a number.
       def numeric?
         !!Float(self)
       rescue ArgumentError
@@ -98,7 +98,7 @@ module Mongoid
       # @example Is the string a setter method?
       #   "model=".writer?
       #
-      # @return [ true, false ] If the string contains "=".
+      # @return [ true | false ] If the string contains "=".
       def writer?
         include?("=")
       end
@@ -108,7 +108,7 @@ module Mongoid
       # @example Is the string a valid Ruby identifier for use as a method name
       #   "model=".valid_method_name?
       #
-      # @return [ true, false ] If the string contains a valid Ruby identifier.
+      # @return [ true | false ] If the string contains a valid Ruby identifier.
       def valid_method_name?
         /[@$"-]/ !~ self
       end
@@ -118,7 +118,7 @@ module Mongoid
       # @example Is the string a setter method?
       #   "price_before_type_cast".before_type_cast?
       #
-      # @return [ true, false ] If the string ends with "_before_type_cast"
+      # @return [ true | false ] If the string ends with "_before_type_cast"
       def before_type_cast?
         ends_with?("_before_type_cast")
       end
@@ -128,7 +128,7 @@ module Mongoid
       # @example Is the object unconvertable?
       #   object.unconvertable_to_bson?
       #
-      # @return [ true, false ] If the object is unconvertable.
+      # @return [ true | false ] If the object is unconvertable.
       def unconvertable_to_bson?
         @unconvertable_to_bson ||= false
       end
@@ -142,7 +142,7 @@ module Mongoid
       # @example Convert to the object id.
       #   string.convert_to_object_id
       #
-      # @return [ String, BSON::ObjectId ] The string or the id.
+      # @return [ String | BSON::ObjectId ] The string or the id.
       def convert_to_object_id
         BSON::ObjectId.legal?(self) ? BSON::ObjectId.from_string(self) : self
       end

data/lib/mongoid/extensions/symbol.rb

@@ -9,7 +9,7 @@ module Mongoid
       # @example Is the string an id value?
       #   :_id.mongoid_id?
       #
-      # @return [ true, false ] If the symbol is :id or :_id.
+      # @return [ true | false ] If the symbol is :id or :_id.
       def mongoid_id?
         to_s.mongoid_id?
       end

data/lib/mongoid/extensions/true_class.rb

@@ -21,7 +21,7 @@ module Mongoid
       #
       # @param [ Class ] other The class to check.
       #
-      # @return [ true, false ] If the other is a boolean.
+      # @return [ true | false ] If the other is a boolean.
       def is_a?(other)
         if other == Mongoid::Boolean || other.class == Mongoid::Boolean
           return true

data/lib/mongoid/fields/foreign_key.rb

@@ -43,7 +43,7 @@ module Mongoid
       # @example Is the field a foreign key?
       #   field.foreign_key?
       #
-      # @return [ true, false ] If the field is a foreign key.
+      # @return [ true | false ] If the field is a foreign key.
       def foreign_key?
         true
       end
@@ -75,7 +75,7 @@ module Mongoid
       # @example Is the field lazy?
       #   field.lazy?
       #
-      # @return [ true, false ] If the field is lazy.
+      # @return [ true | false ] If the field is lazy.
       def lazy?
         type.resizable?
       end
@@ -101,7 +101,7 @@ module Mongoid
       # @example Is the field a BSON::ObjectId?
       #   field.object_id_field?
       #
-      # @return [ true, false ] If the field is a BSON::ObjectId.
+      # @return [ true | false ] If the field is a BSON::ObjectId.
       def object_id_field?
         @object_id_field ||=
             association.polymorphic? ? true : association.klass.using_object_ids?
@@ -112,7 +112,7 @@ module Mongoid
       # @example Is the field resizable?
       #   field.resizable?
       #
-      # @return [ true, false ] If the field is resizable.
+      # @return [ true | false ] If the field is resizable.
       def resizable?
         type.resizable?
       end

data/lib/mongoid/fields/localized.rb

@@ -24,7 +24,7 @@ module Mongoid
       # @example Is the field localized?
       #   field.localized?
       #
-      # @return [ true, false ] If the field is localized.
+      # @return [ true | false ] If the field is localized.
       def localized?
         true
       end
@@ -50,7 +50,7 @@ module Mongoid
       # @example Should fallbacks be used.
       #   field.fallbacks?
       #
-      # @return [ true, false ] If fallbacks should be used.
+      # @return [ true | false ] If fallbacks should be used.
       def fallbacks?
         return true if options[:fallbacks].nil?
         !!options[:fallbacks]

data/lib/mongoid/fields/standard.rb

@@ -48,7 +48,7 @@ module Mongoid
       # @example Is the field a foreign key?
       #   field.foreign_key?
       #
-      # @return [ true, false ] If the field is a foreign key.
+      # @return [ true | false ] If the field is a foreign key.
       def foreign_key?
         false
       end
@@ -82,7 +82,7 @@ module Mongoid
       # @example Is the field lazy?
       #   field.lazy?
       #
-      # @return [ true, false ] If the field is lazy.
+      # @return [ true | false ] If the field is lazy.
       def lazy?
         false
       end
@@ -92,7 +92,7 @@ module Mongoid
       # @example Is the field localized?
       #   field.localized?
       #
-      # @return [ true, false ] If the field is localized.
+      # @return [ true | false ] If the field is localized.
       def localized?
         false
       end
@@ -112,7 +112,7 @@ module Mongoid
       # @example Is the field a BSON::ObjectId?
       #   field.object_id_field?
       #
-      # @return [ true, false ] If the field is a BSON::ObjectId.
+      # @return [ true | false ] If the field is a BSON::ObjectId.
       def object_id_field?
         @object_id_field ||= (type == BSON::ObjectId)
       end
@@ -122,7 +122,7 @@ module Mongoid
       # @example Does the field pre-process the default?
       #   field.pre_processed?
       #
-      # @return [ true, false ] If the field's default is pre-processed.
+      # @return [ true | false ] If the field's default is pre-processed.
       def pre_processed?
         @pre_processed ||=
           (options[:pre_processed] || (default_val && !default_val.is_a?(::Proc)))
@@ -161,7 +161,7 @@ module Mongoid
       #
       # @note Ruby's instance_exec was just too slow.
       #
-      # @param [ Class, Module ] object The class or module the field is
+      # @param [ Class | Module ] object The class or module the field is
       #   defined on.
       def define_default_method(object)
         object.__send__(:define_method, default_name, default_val)
@@ -177,7 +177,7 @@ module Mongoid
       #
       # @param [ Hash ] fields The field limitations.
       #
-      # @return [ true, false ] If the field was included.
+      # @return [ true | false ] If the field was included.
       def included?(fields)
         (fields.values.first == 1 && fields[name.to_s] == 1) ||
           (fields.values.first == 0 && !fields.has_key?(name.to_s))

data/lib/mongoid/fields.rb

@@ -147,7 +147,7 @@ module Mongoid
     # @example Apply all the non-proc defaults.
     #   model.apply_pre_processed_defaults
     #
-    # @return [ Array<String ] The names of the non-proc defaults.
+    # @return [ Array<String> ] The names of the non-proc defaults.
     def apply_pre_processed_defaults
       pre_processed_defaults.each do |name|
         apply_default(name)
@@ -159,7 +159,7 @@ module Mongoid
     # @example Apply all the proc defaults.
     #   model.apply_post_processed_defaults
     #
-    # @return [ Array<String ] The names of the proc defaults.
+    # @return [ Array<String> ] The names of the proc defaults.
     def apply_post_processed_defaults
       pending_callbacks.delete(:apply_post_processed_defaults)
       post_processed_defaults.each do |name|
@@ -214,7 +214,7 @@ module Mongoid
     # @example Get the database field name.
     #   model.database_field_name(:authorization)
     #
-    # @param [ String, Symbol ] name The name to get.
+    # @param [ String | Symbol ] name The name to get.
     #
     # @return [ String ] The name of the field as it's stored in the db.
     def database_field_name(name)
@@ -229,7 +229,7 @@ module Mongoid
     # @param [ Field ] field The field.
     # @param [ Object ] value The current value.
     #
-    # @return [ true, false ] If we set the field lazily.
+    # @return [ true | false ] If we set the field lazily.
     def lazy_settable?(field, value)
       !frozen? && value.nil? && field.lazy?
     end
@@ -241,7 +241,7 @@ module Mongoid
     # @example Is the document using object ids?
     #   model.using_object_ids?
     #
-    # @return [ true, false ] Using object ids.
+    # @return [ true | false ] Using object ids.
     def using_object_ids?
       self.class.using_object_ids?
     end
@@ -252,7 +252,7 @@ module Mongoid
     #
     # @param [ String ] name The field name.
     #
-    # @return [ true, false ] If this field is dotted or dollared.
+    # @return [ true | false ] If this field is dotted or dollared.
     def dot_dollar_field?(name)
       n = aliased_fields[name] || name
       fields.key?(n) && (n.include?('.') || n.start_with?('$'))
@@ -396,7 +396,7 @@ module Mongoid
       # If the belongs_to association is the last part of the name, we will
       # pass back the _id field.
       #
-      # @param [ String, Symbol ] name The name to get.
+      # @param [ String | Symbol ] name The name to get.
       # @param [ Hash ] relations The associations.
       # @param [ Hash ] alaiased_fields The aliased fields.
       # @param [ Hash ] alaiased_associations The aliased associations.
@@ -455,7 +455,7 @@ module Mongoid
       # Get the name of the provided field as it is stored in the database.
       # Used in determining if the field is aliased or not.
       #
-      # @param [ String, Symbol ] name The name to get.
+      # @param [ String | Symbol ] name The name to get.
       #
       # @return [ String ] The name of the field as it's stored in the db.
       def database_field_name(name)
@@ -507,7 +507,7 @@ module Mongoid
       # @example Does this class use object ids?
       #   person.using_object_ids?
       #
-      # @return [ true, false ] If the class uses BSON::ObjectIds for the id.
+      # @return [ true | false ] If the class uses BSON::ObjectIds for the id.
       def using_object_ids?
         fields["_id"].object_id_field?
       end

data/lib/mongoid/findable.rb

@@ -76,7 +76,7 @@ module Mongoid
     # @example Are there no saved documents for this model?
     #   Person.empty?
     #
-    # @return [ true, false ] If the collection is empty.
+    # @return [ true | false ] If the collection is empty.
     def empty?
       count == 0
     end
@@ -87,7 +87,7 @@ module Mongoid
     # @example Do any documents exist for the conditions?
     #   Person.exists?
     #
-    # @return [ true, false ] If any documents exist for the conditions.
+    # @return [ true | false ] If any documents exist for the conditions.
     def exists?
       with_default_scope.exists?
     end
@@ -132,8 +132,10 @@ module Mongoid
     # The +find+ method takes into account the default scope defined on the
     # model class, if any.
     #
-    # @param [ Object | Array<Object> ] args The _id values to find or an
-    #   array thereof.
+    # @note Each argument can be an individual id, an array of ids or
+    #   a nested array. Each array will be flattened.
+    #
+    # @param [ Object | Array<Object> ] *args The _id value(s) to find.
     #
     # @return [ Document | Array<Document> | nil ] A document or matching documents.
     #
@@ -161,7 +163,7 @@ module Mongoid
     # @raise [ Errors::DocumentNotFound ] If no document found
     # and Mongoid.raise_not_found_error is true.
     #
-    # @return [ Document, nil ] A matching document.
+    # @return [ Document | nil ] A matching document.
     def find_by(attrs = {})
       result = where(attrs).find_first
       if result.nil? && Mongoid.raise_not_found_error
@@ -182,7 +184,6 @@ module Mongoid
     # @raise [ Errors::DocumentNotFound ] If no document found.
     #
     # @return [ Document ] A matching document.
-    #
     def find_by!(attrs = {})
       result = where(attrs).find_first
       raise(Errors::DocumentNotFound.new(self, attrs)) unless result

data/lib/mongoid/indexable/specification.rb

@@ -27,7 +27,7 @@ module Mongoid
       #
       # @param [ Specification ] other The spec to compare against.
       #
-      # @return [ true, false ] If the specs are equal.
+      # @return [ true | false ] If the specs are equal.
       def ==(other)
         fields == other.fields && key == other.key
       end

data/lib/mongoid/indexable/validators/options.rb

@@ -28,7 +28,8 @@ module Mongoid
           :text_version,
           :version,
           :partial_filter_expression,
-          :collation
+          :collation,
+          :wildcard_projection,
         ]
 
         VALID_TYPES = [

data/lib/mongoid/interceptable.rb

@@ -53,7 +53,7 @@ module Mongoid
     #
     # @param [ Symbol ] kind The type of callback.
     #
-    # @return [ true, false ] If the callback can be executed.
+    # @return [ true | false ] If the callback can be executed.
     def callback_executable?(kind)
       respond_to?("_#{kind}_callbacks")
     end
@@ -66,7 +66,7 @@ module Mongoid
     #
     # @param [ Symbol ] kind The callback kind.
     #
-    # @return [ true, false ] If the document is in a callback state.
+    # @return [ true | false ] If the document is in a callback state.
     def in_callback_state?(kind)
       [ :create, :destroy ].include?(kind) || new_record? || flagged_for_destroy? || changed?
     end
@@ -195,7 +195,7 @@ module Mongoid
     # @example Was a before callback halted?
     #   document.before_callback_halted?
     #
-    # @return [ true, false ] If a before callback was halted.
+    # @return [ true | false ] If a before callback was halted.
     def before_callback_halted?
       !!@before_callback_halted
     end
@@ -235,7 +235,7 @@ module Mongoid
     # @param [ Symbol ] kind The type of callback.
     # @param [ Document ] child The child document.
     #
-    # @return [ true, false ] If the child should fire the callback.
+    # @return [ true | false ] If the child should fire the callback.
     def cascadable_child?(kind, child, association)
       return false if kind == :initialize || kind == :find || kind == :touch
       return false if kind == :validate && association.validate?

data/lib/mongoid/matchable.rb

@@ -15,7 +15,7 @@ module Mongoid
     #
     # @param [ Hash ] selector The MongoDB selector.
     #
-    # @return [ true, false ] True if matches, false if not.
+    # @return [ true | false ] True if matches, false if not.
     def _matches?(selector)
       Matcher::Expression.matches?(self, selector)
     end

data/lib/mongoid/matcher.rb

@@ -24,17 +24,22 @@ module Mongoid
     #   an array of values of the `bar` field in each of the hashes in the
     #   `foo` array.
     #
-    # The return value is a two-element array. The first element is the value
-    # retrieved, or an array of values. The second element is a boolean flag
-    # indicating whether an array was expanded at any point during the key
-    # traversal (because the respective document field was an array).
+    # This method can return an individual field value in some document
+    # or an array of values from multiple documents. The array can be returned
+    # because a field value in the specified path is an array of primitive
+    # values (e.g. integers) or because a field value in the specified path
+    # is an array of documents (e.g. a one-to-many embedded association),
+    # in which case the leaf value may be a scalar for each individual document.
+    # If the leaf value is an array and a one-to-many association was traversed,
+    # the return value will be an array of arrays. Note that an individual
+    # field value can also be an array and this case is indistinguishable
+    # from and behaves identically to association traversal for the purposes
+    # of, for example, subsequent array element retrieval.
     #
     # @param [ Document | Hash ] document The document to extract from.
     # @param [ String ] key The key path to extract.
     #
-    # @return [ Array<true | false, Object | Array, true | false> ]
-    #   Whether the value existed in the document, the extracted value
-    #   and the array expansion flag.
+    # @return [ Object | Array ] Field value or values.
     module_function def extract_attribute(document, key)
       if document.respond_to?(:as_attributes, true)
         # If a document has hash fields, as_attributes would keep those fields

data/lib/mongoid/persistable/creatable.rb

@@ -132,10 +132,10 @@ module Mongoid
         # @example Create multiple new documents.
         #   Person.create({ title: "Mr" }, { title: "Mrs" })
         #
-        # @param [ Hash, Array ] attributes The attributes to create with, or an
+        # @param [ Hash | Array ] attributes The attributes to create with, or an
         #   Array of multiple attributes for multiple documents.
         #
-        # @return [ Document, Array<Document> ] The newly created document(s).
+        # @return [ Document | Array<Document> ] The newly created document(s).
         def create(attributes = nil, &block)
           _creating do
             if attributes.is_a?(::Array)
@@ -159,10 +159,10 @@ module Mongoid
         # @example Create multiple new documents.
         #   Person.create!({ title: "Mr" }, { title: "Mrs" })
         #
-        # @param [ Hash, Array ] attributes The attributes to create with, or an
+        # @param [ Hash | Array ] attributes The attributes to create with, or an
         #   Array of multiple attributes for multiple documents.
         #
-        # @return [ Document, Array<Document> ] The newly created document(s).
+        # @return [ Document | Array<Document> ] The newly created document(s).
         def create!(attributes = nil, &block)
           _creating do
             if attributes.is_a?(::Array)

data/lib/mongoid/persistable/deletable.rb

@@ -86,7 +86,7 @@ module Mongoid
       #
       # @param [ Hash ] options The delete options.
       #
-      # @return [ true, false ] If the parent should be notified.
+      # @return [ true | false ] If the parent should be notified.
       def notifying_parent?(options = {})
         !options.delete(:suppress)
       end

data/lib/mongoid/persistable/destroyable.rb

@@ -14,7 +14,7 @@ module Mongoid
       #
       # @param [ Hash ] options Options to pass to destroy.
       #
-      # @return [ true, false ] True if successful, false if not.
+      # @return [ true | false ] True if successful, false if not.
       def destroy(options = nil)
         raise Errors::ReadonlyDocument.new(self.class) if readonly?
         self.flagged_for_destroy = true

data/lib/mongoid/persistable/savable.rb

@@ -14,7 +14,7 @@ module Mongoid
       #
       # @param [ Hash ] options Options to pass to the save.
       #
-      # @return [ true, false ] True is success, false if not.
+      # @return [ true | false ] True is success, false if not.
       def save(options = {})
         if new_record?
           !insert(options).new_record?
@@ -34,7 +34,7 @@ module Mongoid
       # @raise [ Errors::Validations ] If validation failed.
       # @raise [ Errors::Callback ] If a callback returns false.
       #
-      # @return [ true, false ] True if validation passed.
+      # @return [ true | false ] True if validation passed.
       def save!(options = {})
         unless save(options)
           fail_due_to_validation! unless errors.empty?

data/lib/mongoid/persistable/unsettable.rb

@@ -13,7 +13,7 @@ module Mongoid
       # @example Unset the values.
       #   document.unset(:first_name, :last_name, :middle)
       #
-      # @param [ Array<String, Symbol> ] fields The names of the fields to
+      # @param [ Array<String | Symbol> ] fields The names of the fields to
       #   unset.
       #
       # @return [ Document ] The document.

data/lib/mongoid/persistable/updatable.rb

@@ -13,13 +13,13 @@ module Mongoid
       # @example Update the attribute.
       #   person.update_attribute(:title, "Sir")
       #
-      # @param [ Symbol, String ] name The name of the attribute.
+      # @param [ Symbol | String ] name The name of the attribute.
       # @param [ Object ] value The new value of the attribute.a
       #
       # @raise [ Errors::ReadonlyAttribute ] If the field cannot be changed due
       #   to being flagged as read-only.
       #
-      # @return [ true, false ] True if save was successful, false if not.
+      # @return [ true | false ] True if save was successful, false if not.
       def update_attribute(name, value)
         as_writable_attribute!(name, value) do |access|
           normalized = name.to_s
@@ -35,7 +35,7 @@ module Mongoid
       #
       # @param [ Hash ] attributes The attributes to update.
       #
-      # @return [ true, false ] True if validation passed, false if not.
+      # @return [ true | false ] True if validation passed, false if not.
       def update(attributes = {})
         assign_attributes(attributes)
         save
@@ -53,7 +53,7 @@ module Mongoid
       # @raise [ Errors::Validations ] If validation failed.
       # @raise [ Errors::Callbacks ] If a callback returns false.
       #
-      # @return [ true, false ] True if validation passed.
+      # @return [ true | false ] True if validation passed.
       def update!(attributes = {})
         result = update_attributes(attributes)
         unless result
@@ -91,7 +91,7 @@ module Mongoid
       #
       # @param [ Hash ] options The options.
       #
-      # @return [ true, false ] The result of the update.
+      # @return [ true | false ] The result of the update.
       def prepare_update(options = {})
         return false if performing_validations?(options) &&
           invalid?(options[:context] || :update)
@@ -119,9 +119,9 @@ module Mongoid
       #
       # @param [ Hash ] options Options to pass to update.
       #
-      # @option options [ true, false ] :validate Whether or not to validate.
+      # @option options [ true | false ] :validate Whether or not to validate.
       #
-      # @return [ true, false ] True if succeeded, false if not.
+      # @return [ true | false ] True if succeeded, false if not.
       def update_document(options = {})
         prepare_update(options) do
           updates, conflicts = init_atomic_updates

data/lib/mongoid/persistable/upsertable.rb

@@ -36,7 +36,7 @@ module Mongoid
       #
       # @param [ Hash ] options The options hash.
       #
-      # @return [ true, false ] If the operation succeeded.
+      # @return [ true | false ] If the operation succeeded.
       def prepare_upsert(options = {})
         return false if performing_validations?(options) && invalid?(:upsert)
         result = run_callbacks(:upsert) do

data/lib/mongoid/persistable.rb

@@ -79,11 +79,11 @@ module Mongoid
     #     document.set name: "Tool"
     #   end
     #
-    # @param [ true, false ] join_context Join the context (i.e. merge
+    # @param [ true | false ] join_context Join the context (i.e. merge
     #   declared atomic operations) of the atomically block wrapping this one
     #   for the same document, if one exists.
     #
-    # @return [ true, false ] If the operation succeeded.
+    # @return [ true | false ] If the operation succeeded.
     def atomically(join_context: nil)
       join_context = Mongoid.join_contexts if join_context.nil?
       call_depth = @atomic_depth ||= 0
@@ -146,7 +146,7 @@ module Mongoid
     # @example Are we executing atomically?
     #   document.executing_atomically?
     #
-    # @return [ true, false ] If we are current executing atomically.
+    # @return [ true | false ] If we are current executing atomically.
     def executing_atomically?
       !@atomic_updates_to_execute_stack.nil?
     end