docs: couple of quick fixes

Automattic · Sep 7, 2022 · 90d4d71 · 90d4d71
1 parent 001dda3
commit 90d4d71
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/lib/aggregate.js b/lib/aggregate.js
@@ -765,7 +765,7 @@ Aggregate.prototype.explain = function(verbosity, callback) {
 };
 
 /**
- * Sets the allowDiskUse option for the aggregation query (ignored for < 2.6.0)
+ * Sets the allowDiskUse option for the aggregation query
  *
  * #### Example:
  *
@@ -782,7 +782,7 @@ Aggregate.prototype.allowDiskUse = function(value) {
 };
 
 /**
- * Sets the hint option for the aggregation query (ignored for < 3.6.0)
+ * Sets the hint option for the aggregation query
  *
  * #### Example:
  *

diff --git a/lib/index.js b/lib/index.js
@@ -306,7 +306,7 @@ Mongoose.prototype.get = Mongoose.prototype.set;
  * @param {Number} [options.connectTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _during initial connection_. Defaults to 30000. This option is passed transparently to [Node.js' `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback).
  * @param {Number} [options.socketTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. This is set to `30000` by default, you should set this to 2-3x your longest running operation if you expect some of your database operations to run longer than 20 seconds. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
  * @param {Number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0`, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
- * @return {Connection} the created Connection object. Connections are not thenable, so you can't do `await mongoose.createConnection()`. To await use mongoose.createConnection(uri).asPromise() instead.
+ * @return {Connection} the created Connection object. Connections are not thenable, so you can't do `await mongoose.createConnection()`. To await use `mongoose.createConnection(uri).asPromise()` instead.
  * @api public
  */
 

diff --git a/types/aggregate.d.ts b/types/aggregate.d.ts
@@ -91,7 +91,7 @@ declare module 'mongoose' {
      */
     addFields(arg: PipelineStage.AddFields['$addFields']): this;
 
-    /** Sets the allowDiskUse option for the aggregation query (ignored for < 2.6.0) */
+    /** Sets the allowDiskUse option for the aggregation query */
     allowDiskUse(value: boolean): this;
 
     /** Appends new operators to this aggregate pipeline */
@@ -111,7 +111,7 @@ declare module 'mongoose' {
     count(fieldName: PipelineStage.Count['$count']): this;
 
     /**
-     * Sets the cursor option for the aggregation query (ignored for < 2.6.0).
+     * Sets the cursor option for the aggregation query
      */
     cursor<DocType = any>(options?: Record<string, unknown>): Cursor<DocType>;
 
@@ -134,7 +134,7 @@ declare module 'mongoose' {
     /** Appends new custom $group operator to this aggregate pipeline. */
     group(arg: PipelineStage.Group['$group']): this;
 
-    /** Sets the hint option for the aggregation query (ignored for < 3.6.0) */
+    /** Sets the hint option for the aggregation query */
     hint(value: Record<string, unknown> | string): this;
 
     /**