Skip to content

Commit 8f37256

Browse files
ehersheyskriptble
authored andcommitted
Comment fixups
1 parent a7eb0f4 commit 8f37256

11 files changed

+18
-18
lines changed

mongo/index_view.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ func (iv IndexView) CreateOne(ctx context.Context, model IndexModel, opts ...*op
9292
}
9393

9494
// CreateMany creates multiple indexes in the collection specified by the models. The names of the
95-
// creates indexes are returned.
95+
// created indexes are returned.
9696
func (iv IndexView) CreateMany(ctx context.Context, models []IndexModel, opts ...*options.CreateIndexesOptions) ([]string, error) {
9797
names := make([]string, 0, len(models))
9898
indexes := bsonx.Arr{}

mongo/options/aggregateoptions.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ package options
88

99
import "time"
1010

11-
// AggregateOptions represents all possible options to the aggregate() function
11+
// AggregateOptions represents all possible options to the Aggregate() function.
1212
type AggregateOptions struct {
1313
AllowDiskUse *bool // Enables writing to temporary files. When set to true, aggregation stages can write data to the _tmp subdirectory in the dbPath directory
1414
BatchSize *int32 // The number of documents to return per batch

mongo/options/countoptions.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ package options
88

99
import "time"
1010

11-
// CountOptions represents all possible options to the count() function
11+
// CountOptions represents all possible options to the Count() function.
1212
type CountOptions struct {
1313
Collation *Collation // Specifies a collation
1414
Hint interface{} // The index to use

mongo/options/deleteoptions.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
package options
88

9-
// DeleteOptions represents all possible options to the deleteOne() and deleteMany() functions
9+
// DeleteOptions represents all possible options to the DeleteOne() and DeleteMany() functions.
1010
type DeleteOptions struct {
1111
Collation *Collation // Specifies a collation
1212
}

mongo/options/distinctoptions.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ package options
88

99
import "time"
1010

11-
// DistinctOptions represents all possible options to the distinct() function
11+
// DistinctOptions represents all possible options to the Distinct() function.
1212
type DistinctOptions struct {
1313
Collation *Collation // Specifies a collation
1414
MaxTime *time.Duration // The maximum amount of time to allow the operation to run

mongo/options/estimatedcountoptions.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ package options
88

99
import "time"
1010

11-
// EstimatedDocumentCountOptions represents all possible options to the estimatedDocumentCount() function
11+
// EstimatedDocumentCountOptions represents all possible options to the EstimatedDocumentCount() function.
1212
type EstimatedDocumentCountOptions struct {
1313
MaxTime *time.Duration // The maximum amount of time to allow the operation to run
1414
}

mongo/options/findoptions.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"time"
1111
)
1212

13-
// FindOptions represent all possible options to the find() function.
13+
// FindOptions represent all possible options to the Find() function.
1414
type FindOptions struct {
1515
AllowPartialResults *bool // If true, allows partial results to be returned if some shards are down.
1616
BatchSize *int32 // Specifies the number of documents to return in every batch.
@@ -230,7 +230,7 @@ func MergeFindOptions(opts ...*FindOptions) *FindOptions {
230230
return fo
231231
}
232232

233-
// FindOneOptions represent all possible options to the findOne() function.
233+
// FindOneOptions represent all possible options to the FindOne() function.
234234
type FindOneOptions struct {
235235
AllowPartialResults *bool // If true, allows partial results to be returned if some shards are down.
236236
BatchSize *int32 // Specifies the number of documents to return in every batch.
@@ -433,7 +433,7 @@ func MergeFindOneOptions(opts ...*FindOneOptions) *FindOneOptions {
433433
return fo
434434
}
435435

436-
// FindOneAndReplaceOptions represent all possible options to the findOne() function.
436+
// FindOneAndReplaceOptions represent all possible options to the FindOneAndReplace() function.
437437
type FindOneAndReplaceOptions struct {
438438
BypassDocumentValidation *bool // If true, allows the write to opt out of document-level validation.
439439
Collation *Collation // Specifies a collation to be used
@@ -527,7 +527,7 @@ func MergeFindOneAndReplaceOptions(opts ...*FindOneAndReplaceOptions) *FindOneAn
527527
return fo
528528
}
529529

530-
// FindOneAndUpdateOptions represent all possible options to the findOne() function.
530+
// FindOneAndUpdateOptions represent all possible options to the FindOneAndUpdate() function.
531531
type FindOneAndUpdateOptions struct {
532532
ArrayFilters *ArrayFilters // A set of filters specifying to which array elements an update should apply.
533533
BypassDocumentValidation *bool // If true, allows the write to opt out of document-level validation.
@@ -630,7 +630,7 @@ func MergeFindOneAndUpdateOptions(opts ...*FindOneAndUpdateOptions) *FindOneAndU
630630
return fo
631631
}
632632

633-
// FindOneAndDeleteOptions represent all possible options to the findOne() function.
633+
// FindOneAndDeleteOptions represent all possible options to the FindOneAndDelete() function.
634634
type FindOneAndDeleteOptions struct {
635635
Collation *Collation // Specifies a collation to be used
636636
MaxTime *time.Duration // Specifies the maximum amount of time to allow the query to run.

mongo/options/indexoptions.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"time"
1111
)
1212

13-
// CreateIndexesOptions represents all possible options for the create() function.
13+
// CreateIndexesOptions represents all possible options for the CreateOne() and CreateMany() functions.
1414
type CreateIndexesOptions struct {
1515
MaxTime *time.Duration // The maximum amount of time to allow the query to run.
1616
}
@@ -42,7 +42,7 @@ func MergeCreateIndexesOptions(opts ...*CreateIndexesOptions) *CreateIndexesOpti
4242
return c
4343
}
4444

45-
// DropIndexesOptions represents all possible options for the create() function.
45+
// DropIndexesOptions represents all possible options for the DropIndexes() function.
4646
type DropIndexesOptions struct {
4747
MaxTime *time.Duration
4848
}
@@ -74,7 +74,7 @@ func MergeDropIndexesOptions(opts ...*DropIndexesOptions) *DropIndexesOptions {
7474
return c
7575
}
7676

77-
// ListIndexesOptions represents all possible options for the create() function.
77+
// ListIndexesOptions represents all possible options for the ListIndexes() function.
7878
type ListIndexesOptions struct {
7979
BatchSize *int32
8080
MaxTime *time.Duration

mongo/options/insertoptions.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
package options
88

9-
// InsertOneOptions represents all possible options to the insertOne()
9+
// InsertOneOptions represents all possible options to the InsertOne() function.
1010
type InsertOneOptions struct {
1111
BypassDocumentValidation *bool // If true, allows the write to opt-out of document level validation
1212
}
@@ -38,7 +38,7 @@ func MergeInsertOneOptions(opts ...*InsertOneOptions) *InsertOneOptions {
3838
return ioOpts
3939
}
4040

41-
// InsertManyOptions represents all possible options to the insertMany()
41+
// InsertManyOptions represents all possible options to the InsertMany() function.
4242
type InsertManyOptions struct {
4343
BypassDocumentValidation *bool // If true, allows the write to opt-out of document level validation
4444
Ordered *bool // If true, when an insert fails, return without performing the remaining inserts. Defaults to true.

mongo/options/replaceoptions.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
package options
88

9-
// ReplaceOptions represents all possible options to the replaceOne() function
9+
// ReplaceOptions represents all possible options to the ReplaceOne() function.
1010
type ReplaceOptions struct {
1111
BypassDocumentValidation *bool // If true, allows the write to opt-out of document level validation
1212
Collation *Collation // Specifies a collation

0 commit comments

Comments
 (0)