Skip to content

Commit

Permalink
GODRIVER-2698 Update comments to include document
Browse files Browse the repository at this point in the history
  • Loading branch information
prestonvasquez committed Nov 28, 2023
1 parent 7c66958 commit e107efd
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
5 changes: 3 additions & 2 deletions mongo/options/aggregateoptions.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ type AggregateOptions struct {
// This option is only valid for MongoDB versions >= 3.2 and is ignored for previous server versions.
MaxAwaitTime *time.Duration

// A string that will be included in server logs, profiling logs, and currentOp queries to help trace the operation.
// The default is nil, which means that no comment will be included in the logs.
// A string or document that will be included in server logs, profiling logs,
// and currentOp queries to help trace the operation. The default is nil,
// which means that no comment will be included in the logs.
Comment interface{}

// The index to use for the aggregation. This should either be the index name as a string or the index specification
Expand Down
5 changes: 3 additions & 2 deletions mongo/options/changestreamoptions.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ type ChangeStreamOptions struct {
// default value is nil, which means the default collation of the collection will be used.
Collation *Collation

// A string that will be included in server logs, profiling logs, and currentOp queries to help trace the operation.
// The default is nil, which means that no comment will be included in the logs.
// A string or document that will be included in server logs, profiling logs,
// and currentOp queries to help trace the operation. The default is nil,
// which means that no comment will be included in the logs.
Comment interface{}

// Specifies how the updated document should be returned in change notifications for update operations. The default
Expand Down
10 changes: 6 additions & 4 deletions mongo/options/findoptions.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ type FindOptions struct {
// default value is nil, which means the default collation of the collection will be used.
Collation *Collation

// A string that will be included in server logs, profiling logs, and currentOp queries to help trace the operation.
// The default is nil, which means that no comment will be included in the logs.
// A string or document that will be included in server logs, profiling logs,
// and currentOp queries to help trace the operation. The default is nil,
// which means that no comment will be included in the logs.
Comment interface{}

// CursorType specifies the type of cursor that should be created for the operation. The default is NonTailable, which
Expand Down Expand Up @@ -233,8 +234,9 @@ type FindOneOptions struct {
// default value is nil, which means the default collation of the collection will be used.
Collation *Collation

// A string that will be included in server logs, profiling logs, and currentOp queries to help trace the operation.
// The default is nil, which means that no comment will be included in the logs.
// A string or document that will be included in server logs, profiling logs,
// and currentOp queries to help trace the operation. The default is nil,
// which means that no comment will be included in the logs.
Comment interface{}

// The index to use for the aggregation. This should either be the index name as a string or the index specification
Expand Down

0 comments on commit e107efd

Please sign in to comment.