Skip to content

Commit 0838e97

Browse files
committed
docs(NODE-5484): Refine docs
1 parent d8ee589 commit 0838e97

File tree

4 files changed

+84
-42
lines changed

4 files changed

+84
-42
lines changed

src/bulk/common.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -599,7 +599,8 @@ export class MongoBulkWriteError extends MongoServerError {
599599
err?: WriteConcernError;
600600

601601
/**
602-
* Do not use this constructor. It is meant for internal use only.
602+
* **Do not use this constructor!**
603+
* Meant for internal use only.
603604
*
604605
* @remarks
605606
* This class is only meant to be constructed within the driver. As such this constructor is

src/client-side-encryption/errors.ts

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ import { MongoError } from '../error';
77
*/
88
export class MongoCryptError extends MongoError {
99
/**
10-
* Do not use this constructor. It is meant for internal use only.
10+
* **Do not use this constructor!**
11+
* Meant for internal use only.
1112
*
1213
* @remarks
1314
* This class is only meant to be constructed within the driver. As such this constructor is
@@ -31,7 +32,8 @@ export class MongoCryptError extends MongoError {
3132
*/
3233
export class MongoCryptInvalidArgumentError extends MongoCryptError {
3334
/**
34-
* Do not use this constructor. It is meant for internal use only.
35+
* **Do not use this constructor!**
36+
* Meant for internal use only.
3537
*
3638
* @remarks
3739
* This class is only meant to be constructed within the driver. As such this constructor is
@@ -54,7 +56,8 @@ export class MongoCryptInvalidArgumentError extends MongoCryptError {
5456
export class MongoCryptCreateDataKeyError extends MongoCryptError {
5557
encryptedFields: Document;
5658
/**
57-
* Do not use this constructor. It is meant for internal use only.
59+
* **Do not use this constructor!**
60+
* Meant for internal use only.
5861
*
5962
* @remarks
6063
* This class is only meant to be constructed within the driver. As such this constructor is
@@ -79,7 +82,8 @@ export class MongoCryptCreateDataKeyError extends MongoCryptError {
7982
export class MongoCryptCreateEncryptedCollectionError extends MongoCryptError {
8083
encryptedFields: Document;
8184
/**
82-
* Do not use this constructor. It is meant for internal use only.
85+
* **Do not use this constructor!**
86+
* Meant for internal use only.
8387
*
8488
* @remarks
8589
* This class is only meant to be constructed within the driver. As such this constructor is
@@ -105,7 +109,8 @@ export class MongoCryptAzureKMSRequestError extends MongoCryptError {
105109
/** The body of the http response that failed, if present. */
106110
body?: Document;
107111
/**
108-
* Do not use this constructor. It is meant for internal use only.
112+
* **Do not use this constructor!**
113+
* Meant for internal use only.
109114
*
110115
* @remarks
111116
* This class is only meant to be constructed within the driver. As such this constructor is

src/cmap/errors.ts

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ export class PoolClosedError extends MongoDriverError {
1010
address: string;
1111

1212
/**
13-
* Do not use this constructor. It is meant for internal use only.
13+
* **Do not use this constructor!**
14+
* Meant for internal use only.
1415
*
1516
* @remarks
1617
* This class is only meant to be constructed within the driver. As such this constructor is
@@ -37,7 +38,8 @@ export class PoolClearedError extends MongoNetworkError {
3738
address: string;
3839

3940
/**
40-
* Do not use this constructor. It is meant for internal use only.
41+
* **Do not use this constructor!**
42+
* Meant for internal use only.
4143
*
4244
* @remarks
4345
* This class is only meant to be constructed within the driver. As such this constructor is
@@ -66,7 +68,8 @@ export class PoolClearedError extends MongoNetworkError {
6668
*/
6769
export class PoolClearedOnNetworkError extends PoolClearedError {
6870
/**
69-
* Do not use this constructor. It is meant for internal use only.
71+
* **Do not use this constructor!**
72+
* Meant for internal use only.
7073
*
7174
* @remarks
7275
* This class is only meant to be constructed within the driver. As such this constructor is
@@ -92,7 +95,8 @@ export class WaitQueueTimeoutError extends MongoDriverError {
9295
address: string;
9396

9497
/**
95-
* Do not use this constructor. It is meant for internal use only.
98+
* **Do not use this constructor!**
99+
* Meant for internal use only.
96100
*
97101
* @remarks
98102
* This class is only meant to be constructed within the driver. As such this constructor is

0 commit comments

Comments
 (0)