docs(estimatedDocumentCount): Documentation for countDocuments mentions estimatedDocumentCount (#2020)

rosemaryy · daprahamian · commit c0b29c42b40b · 2019-08-13T10:00:32.000-04:00
* Documentation for countDocuments MUST mention estimatedDocumentCount * mentions estimatedDocumentCount in documentation for countDocuments and made estimatedDocumentCount a link. Fixes NODE-1981
diff --git a/lib/collection.js b/lib/collection.js
@@ -1380,7 +1380,7 @@ Collection.prototype.estimatedDocumentCount = function(options, callback) {
 
 /**
  * Gets the number of documents matching the filter.
- *
+ * For a fast count of the total documents in a collection see {@link Collection#estimatedDocumentCount estimatedDocumentCount}.
  * **Note**: When migrating from {@link Collection#count count} to {@link Collection#countDocuments countDocuments}
  * the following query operators must be replaced:
  *

Original file line number	Diff line number	Diff line change
`@@ -1380,7 +1380,7 @@ Collection.prototype.estimatedDocumentCount = function(options, callback) {`
`1380`	`1380`
`1381`	`1381`	`/**`
`1382`	`1382`	`* Gets the number of documents matching the filter.`
`1383`		`- *`
	`1383`	`+ * For a fast count of the total documents in a collection see {@link Collection#estimatedDocumentCount estimatedDocumentCount}.`
`1384`	`1384`	`* Note: When migrating from {@link Collection#count count} to {@link Collection#countDocuments countDocuments}`
`1385`	`1385`	`* the following query operators must be replaced:`
`1386`	`1386`	`*`