Skip to content

Commit 7120ef7

Browse files
committed
docs(NODE-5484): formatting and wording
1 parent 0838e97 commit 7120ef7

File tree

4 files changed

+126
-84
lines changed

4 files changed

+126
-84
lines changed

src/bulk/common.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -600,11 +600,12 @@ export class MongoBulkWriteError extends MongoServerError {
600600

601601
/**
602602
* **Do not use this constructor!**
603+
*
603604
* Meant for internal use only.
604605
*
605606
* @remarks
606-
* This class is only meant to be constructed within the driver. As such this constructor is
607-
* not subject to compatibility guarantees under semantic versioning and may change at any time.
607+
* This class is only meant to be constructed within the driver. This constructor is
608+
* not subject to semantic versioning compatiblity guarantees and may change at any time.
608609
*
609610
* @public
610611
**/

src/client-side-encryption/errors.ts

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ import { MongoError } from '../error';
88
export class MongoCryptError extends MongoError {
99
/**
1010
* **Do not use this constructor!**
11+
*
1112
* Meant for internal use only.
1213
*
1314
* @remarks
14-
* This class is only meant to be constructed within the driver. As such this constructor is
15-
* not subject to compatibility guarantees under semantic versioning and may change at any time.
15+
* This class is only meant to be constructed within the driver. This constructor is
16+
* not subject to semantic versioning compatiblity guarantees and may change at any time.
1617
*
1718
* @public
1819
**/
@@ -33,11 +34,12 @@ export class MongoCryptError extends MongoError {
3334
export class MongoCryptInvalidArgumentError extends MongoCryptError {
3435
/**
3536
* **Do not use this constructor!**
37+
*
3638
* Meant for internal use only.
3739
*
3840
* @remarks
39-
* This class is only meant to be constructed within the driver. As such this constructor is
40-
* not subject to compatibility guarantees under semantic versioning and may change at any time.
41+
* This class is only meant to be constructed within the driver. This constructor is
42+
* not subject to semantic versioning compatiblity guarantees and may change at any time.
4143
*
4244
* @public
4345
**/
@@ -57,11 +59,12 @@ export class MongoCryptCreateDataKeyError extends MongoCryptError {
5759
encryptedFields: Document;
5860
/**
5961
* **Do not use this constructor!**
62+
*
6063
* Meant for internal use only.
6164
*
6265
* @remarks
63-
* This class is only meant to be constructed within the driver. As such this constructor is
64-
* not subject to compatibility guarantees under semantic versioning and may change at any time.
66+
* This class is only meant to be constructed within the driver. This constructor is
67+
* not subject to semantic versioning compatiblity guarantees and may change at any time.
6568
*
6669
* @public
6770
**/
@@ -83,11 +86,12 @@ export class MongoCryptCreateEncryptedCollectionError extends MongoCryptError {
8386
encryptedFields: Document;
8487
/**
8588
* **Do not use this constructor!**
89+
*
8690
* Meant for internal use only.
8791
*
8892
* @remarks
89-
* This class is only meant to be constructed within the driver. As such this constructor is
90-
* not subject to compatibility guarantees under semantic versioning and may change at any time.
93+
* This class is only meant to be constructed within the driver. This constructor is
94+
* not subject to semantic versioning compatiblity guarantees and may change at any time.
9195
*
9296
* @public
9397
**/
@@ -110,11 +114,12 @@ export class MongoCryptAzureKMSRequestError extends MongoCryptError {
110114
body?: Document;
111115
/**
112116
* **Do not use this constructor!**
117+
*
113118
* Meant for internal use only.
114119
*
115120
* @remarks
116-
* This class is only meant to be constructed within the driver. As such this constructor is
117-
* not subject to compatibility guarantees under semantic versioning and may change at any time.
121+
* This class is only meant to be constructed within the driver. This constructor is
122+
* not subject to semantic versioning compatiblity guarantees and may change at any time.
118123
*
119124
* @public
120125
**/

src/cmap/errors.ts

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ export class PoolClosedError extends MongoDriverError {
1111

1212
/**
1313
* **Do not use this constructor!**
14+
*
1415
* Meant for internal use only.
1516
*
1617
* @remarks
17-
* This class is only meant to be constructed within the driver. As such this constructor is
18-
* not subject to compatibility guarantees under semantic versioning and may change at any time.
18+
* This class is only meant to be constructed within the driver. This constructor is
19+
* not subject to semantic versioning compatiblity guarantees and may change at any time.
1920
*
2021
* @public
2122
**/
@@ -39,11 +40,12 @@ export class PoolClearedError extends MongoNetworkError {
3940

4041
/**
4142
* **Do not use this constructor!**
43+
*
4244
* Meant for internal use only.
4345
*
4446
* @remarks
45-
* This class is only meant to be constructed within the driver. As such this constructor is
46-
* not subject to compatibility guarantees under semantic versioning and may change at any time.
47+
* This class is only meant to be constructed within the driver. This constructor is
48+
* not subject to semantic versioning compatiblity guarantees and may change at any time.
4749
*
4850
* @public
4951
**/
@@ -69,11 +71,12 @@ export class PoolClearedError extends MongoNetworkError {
6971
export class PoolClearedOnNetworkError extends PoolClearedError {
7072
/**
7173
* **Do not use this constructor!**
74+
*
7275
* Meant for internal use only.
7376
*
7477
* @remarks
75-
* This class is only meant to be constructed within the driver. As such this constructor is
76-
* not subject to compatibility guarantees under semantic versioning and may change at any time.
78+
* This class is only meant to be constructed within the driver. This constructor is
79+
* not subject to semantic versioning compatiblity guarantees and may change at any time.
7780
*
7881
* @public
7982
**/
@@ -96,11 +99,12 @@ export class WaitQueueTimeoutError extends MongoDriverError {
9699

97100
/**
98101
* **Do not use this constructor!**
102+
*
99103
* Meant for internal use only.
100104
*
101105
* @remarks
102-
* This class is only meant to be constructed within the driver. As such this constructor is
103-
* not subject to compatibility guarantees under semantic versioning and may change at any time.
106+
* This class is only meant to be constructed within the driver. This constructor is
107+
* not subject to semantic versioning compatiblity guarantees and may change at any time.
104108
*
105109
* @public
106110
**/

0 commit comments

Comments
 (0)