Skip to content

Commit 34df9cb

Browse files
committed
edit
1 parent 3180407 commit 34df9cb

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

mongo/options/aggregateoptions.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ func (ao *AggregateOptionsBuilder) SetAllowDiskUse(b bool) *AggregateOptionsBuil
5656
return ao
5757
}
5858

59-
// SetBatchSize sets the value for the BatchSize field. The maximum number of documents to be included
60-
// in each batch returned by the server.
59+
// SetBatchSize sets the value for the BatchSize field. Specifies the maximum number of documents
60+
// to be included in each batch returned by the server.
6161
func (ao *AggregateOptionsBuilder) SetBatchSize(i int32) *AggregateOptionsBuilder {
6262
ao.Opts = append(ao.Opts, func(opts *AggregateOptions) error {
6363
opts.BatchSize = &i
@@ -97,9 +97,9 @@ func (ao *AggregateOptionsBuilder) SetCollation(c *Collation) *AggregateOptionsB
9797
return ao
9898
}
9999

100-
// SetMaxAwaitTime sets the value for the MaxAwaitTime field. The maximum amount of time that the
101-
// server should wait for new documents to satisfy a tailable cursor query. This option is only valid
102-
// for MongoDB versions >= 3.2 and is ignored for previous server versions.
100+
// SetMaxAwaitTime sets the value for the MaxAwaitTime field. Specifies maximum amount of time
101+
// that the server should wait for new documents to satisfy a tailable cursor query. This option is
102+
// only valid for MongoDB versions >= 3.2 and is ignored for previous server versions.
103103
func (ao *AggregateOptionsBuilder) SetMaxAwaitTime(d time.Duration) *AggregateOptionsBuilder {
104104
ao.Opts = append(ao.Opts, func(opts *AggregateOptions) error {
105105
opts.MaxAwaitTime = &d
@@ -110,7 +110,7 @@ func (ao *AggregateOptionsBuilder) SetMaxAwaitTime(d time.Duration) *AggregateOp
110110
return ao
111111
}
112112

113-
// SetComment sets the value for the Comment field. A string or document that will be included in
113+
// SetComment sets the value for the Comment field. Specifies a string or document that will be included in
114114
// server logs, profiling logs, and currentOp queries to help trace the operation. The default is nil,
115115
// which means that no comment will be included in the logs.
116116
func (ao *AggregateOptionsBuilder) SetComment(comment interface{}) *AggregateOptionsBuilder {
@@ -123,8 +123,8 @@ func (ao *AggregateOptionsBuilder) SetComment(comment interface{}) *AggregateOpt
123123
return ao
124124
}
125125

126-
// SetHint sets the value for the Hint field. The index to use for the aggregation. This should either
127-
// be the index name as a string or the index specification as a document. The hint does not apply to
126+
// SetHint sets the value for the Hint field. Specifies the index to use for the aggregation. This should
127+
// either be the index name as a string or the index specification as a document. The hint does not apply to
128128
// $lookup and $graphLookup aggregation stages. The driver will return an error if the hint parameter
129129
// is a multi-key map. The default value is nil, which means that no hint will be sent.
130130
func (ao *AggregateOptionsBuilder) SetHint(h interface{}) *AggregateOptionsBuilder {

0 commit comments

Comments
 (0)