update comments.

Author: qingyang-hu

mongo/bulk_write_models.go

@@ -183,8 +183,9 @@ func (rom *ReplaceOneModel) SetUpsert(upsert bool) *ReplaceOneModel {
 }
 
 // SetSort specifies which document the operation replaces if the query matches multiple documents. The first document
-// matched by the sort order will be replaced. This option is only valid for MongoDB versions >= 8.0. The driver will
-// return an error if the sort parameter is a multi-key map. The default value is nil.
+// matched by the sort order will be replaced. This option is only valid for MongoDB versions >= 8.0. The sort parameter
+// is evaluated sequentially, so the driver will return an error if it is a multi-key map (which is unordeded). The
+// default value is nil.
 func (rom *ReplaceOneModel) SetSort(sort interface{}) *ReplaceOneModel {
 	rom.Sort = sort
 	return rom
@@ -259,8 +260,9 @@ func (uom *UpdateOneModel) SetUpsert(upsert bool) *UpdateOneModel {
 }
 
 // SetSort specifies which document the operation updates if the query matches multiple documents. The first document
-// matched by the sort order will be updated. This option is only valid for MongoDB versions >= 8.0. The driver will
-// return an error if the sort parameter is a multi-key map. The default value is nil.
+// matched by the sort order will be updated. This option is only valid for MongoDB versions >= 8.0. The sort parameter
+// is evaluated sequentially, so the driver will return an error if it is a multi-key map (which is unordeded). The
+// default value is nil.
 func (uom *UpdateOneModel) SetSort(sort interface{}) *UpdateOneModel {
 	uom.Sort = sort
 	return uom

mongo/client_bulk_write_models.go

@@ -107,8 +107,9 @@ func (uom *ClientUpdateOneModel) SetUpsert(upsert bool) *ClientUpdateOneModel {
 }
 
 // SetSort specifies which document the operation updates if the query matches multiple documents. The first document
-// matched by the sort order will be updated. This option is only valid for MongoDB versions >= 8.0. The driver will
-// return an error if the sort parameter is a multi-key map. The default value is nil.
+// matched by the sort order will be updated. This option is only valid for MongoDB versions >= 8.0. The sort parameter
+// is evaluated sequentially, so the driver will return an error if it is a multi-key map (which is unordeded). The
+// default value is nil.
 func (uom *ClientUpdateOneModel) SetSort(sort interface{}) *ClientUpdateOneModel {
 	uom.Sort = sort
 	return uom
@@ -233,8 +234,9 @@ func (rom *ClientReplaceOneModel) SetUpsert(upsert bool) *ClientReplaceOneModel
 }
 
 // SetSort specifies which document the operation replaces if the query matches multiple documents. The first document
-// matched by the sort order will be replaced. This option is only valid for MongoDB versions >= 8.0. The driver will
-// return an error if the sort parameter is a multi-key map. The default value is nil.
+// matched by the sort order will be replaced. This option is only valid for MongoDB versions >= 8.0. The sort parameter
+// is evaluated sequentially, so the driver will return an error if it is a multi-key map (which is unordeded). The
+// default value is nil.
 func (rom *ClientReplaceOneModel) SetSort(sort interface{}) *ClientReplaceOneModel {
 	rom.Sort = sort
 	return rom

mongo/options/findoptions.go

@@ -258,8 +258,8 @@ func (f *FindOptionsBuilder) SetSkip(i int64) *FindOptionsBuilder {
 }
 
 // SetSort sets the value for the Sort field. Sort is a document specifying the order in which
-// documents should be returned.  The driver will return an error if the sort parameter is a
-// multi-key map.
+// documents should be returned. The sort parameter is evaluated sequentially, so the driver will
+// return an error if it is a multi-key map (which is unordeded). The default value is nil.
 func (f *FindOptionsBuilder) SetSort(sort interface{}) *FindOptionsBuilder {
 	f.Opts = append(f.Opts, func(opts *FindOptions) error {
 		opts.Sort = sort
@@ -426,8 +426,9 @@ func (f *FindOneOptionsBuilder) SetSkip(i int64) *FindOneOptionsBuilder {
 }
 
 // SetSort sets the value for the Sort field. Sets a document specifying the sort order to
-// apply to the query. The first document in the sorted order will be returned. The driver
-// will return an error if the sort parameter is a multi-key map.
+// apply to the query. The first document in the sorted order will be returned. The sort
+// parameter is evaluated sequentially, so the driver will return an error if it is a multi-
+// key map (which is unordeded). The default value is nil.
 func (f *FindOneOptionsBuilder) SetSort(sort interface{}) *FindOneOptionsBuilder {
 	f.Opts = append(f.Opts, func(opts *FindOneOptions) error {
 		opts.Sort = sort
@@ -539,8 +540,9 @@ func (f *FindOneAndReplaceOptionsBuilder) SetReturnDocument(rd ReturnDocument) *
 
 // SetSort sets the value for the Sort field. Sets a document specifying which document should
 // be replaced if the filter used by the operation matches multiple documents in the collection.
-// If set, the first document in the sorted order will be replaced. The driver will return an
-// error if the sort parameter is a multi-key map. The default value is nil.
+// If set, the first document in the sorted order will be replaced. The sort parameter is evaluated
+// sequentially, so the driver will return an error if it is a multi-key map (which is unordeded).
+// The default value is nil.
 func (f *FindOneAndReplaceOptionsBuilder) SetSort(sort interface{}) *FindOneAndReplaceOptionsBuilder {
 	f.Opts = append(f.Opts, func(opts *FindOneAndReplaceOptions) error {
 		opts.Sort = sort
@@ -716,8 +718,9 @@ func (f *FindOneAndUpdateOptionsBuilder) SetReturnDocument(rd ReturnDocument) *F
 
 // SetSort sets the value for the Sort field. Sets a document specifying which document should
 // be updated if the filter used by the operation matches multiple documents in the collection.
-// If set, the first document in the sorted order will be updated. The driver will return an
-// error if the sort parameter is a multi-key map. The default value is nil.
+// If set, the first document in the sorted order will be updated. The sort parameter is evaluated
+// sequentially, so the driver will return an error if it is a multi-key map (which is unordeded).
+// The default value is nil.
 func (f *FindOneAndUpdateOptionsBuilder) SetSort(sort interface{}) *FindOneAndUpdateOptionsBuilder {
 	f.Opts = append(f.Opts, func(opts *FindOneAndUpdateOptions) error {
 		opts.Sort = sort
@@ -846,8 +849,9 @@ func (f *FindOneAndDeleteOptionsBuilder) SetProjection(projection interface{}) *
 
 // SetSort sets the value for the Sort field. Sets a document specifying which document should
 // be replaced if the filter used by the operation matches multiple documents in the collection.
-// If set, the first document in the sorted order will be selected for replacement. The driver
-// will return an error if the sort parameter is a multi-key map. The default value is nil.
+// If set, the first document in the sorted order will be deleted. The sort parameter is evaluated
+// sequentially, so the driver will return an error if it is a multi-key map (which is unordeded).
+// The default value is nil.
 func (f *FindOneAndDeleteOptionsBuilder) SetSort(sort interface{}) *FindOneAndDeleteOptionsBuilder {
 	f.Opts = append(f.Opts, func(opts *FindOneAndDeleteOptions) error {
 		opts.Sort = sort

mongo/options/gridfsoptions.go

@@ -328,8 +328,9 @@ func (f *GridFSFindOptionsBuilder) SetSkip(i int32) *GridFSFindOptionsBuilder {
 }
 
 // SetSort sets the value for the Sort field. Sets a document specifying the order
-// in which documents should be returned. The driver will return an error if the
-// sort parameter is a multi-key map.
+// in which documents should be returned. The sort parameter is evaluated sequentially,
+// so the driver will return an error if it is a multi-key map (which is unordeded).
+// The default value is nil.
 func (f *GridFSFindOptionsBuilder) SetSort(sort interface{}) *GridFSFindOptionsBuilder {
 	f.Opts = append(f.Opts, func(opts *GridFSFindOptions) error {
 		opts.Sort = sort

mongo/options/replaceoptions.go

@@ -127,8 +127,8 @@ func (ro *ReplaceOptionsBuilder) SetLet(l interface{}) *ReplaceOptionsBuilder {
 // SetSort sets the value for the Sort field. Specifies a document specifying which document should
 // be replaced if the filter used by the operation matches multiple documents in the collection. If
 // set, the first document in the sorted order will be replaced. This option is only valid for MongoDB
-// versions >= 8.0. The driver will return an error if the sort parameter is a multi-key map. The
-// default value is nil.
+// versions >= 8.0. The sort parameter is evaluated sequentially, so the driver will return an error
+// if it is a multi-key map (which is unordeded). The default value is nil.
 func (ro *ReplaceOptionsBuilder) SetSort(s interface{}) *ReplaceOptionsBuilder {
 	ro.Opts = append(ro.Opts, func(opts *ReplaceOptions) error {
 		opts.Sort = s

mongo/options/updateoptions.go

@@ -141,8 +141,8 @@ func (uo *UpdateOneOptionsBuilder) SetLet(l interface{}) *UpdateOneOptionsBuilde
 // SetSort sets the value for the Sort field. Specifies a document specifying which document should
 // be updated if the filter used by the operation matches multiple documents in the collection. If
 // set, the first document in the sorted order will be updated. This option is only valid for MongoDB
-// versions >= 8.0. The driver will return an error if the sort parameter is a multi-key map. The
-// default value is nil.
+// versions >= 8.0. The sort parameter is evaluated sequentially, so the driver will return an error
+// if it is a multi-key map (which is unordeded). The default value is nil.
 func (uo *UpdateOneOptionsBuilder) SetSort(s interface{}) *UpdateOneOptionsBuilder {
 	uo.Opts = append(uo.Opts, func(opts *UpdateOneOptions) error {
 		opts.Sort = s