Skip to content

Commit bae5c2e

Browse files
committed
Add period to constructor doc comment
1 parent f694fe1 commit bae5c2e

File tree

3 files changed

+13
-12
lines changed

3 files changed

+13
-12
lines changed

common/api-review/functions.api.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ export interface Functions {
1919

2020
// @public
2121
export class FunctionsError extends FirebaseError {
22-
constructor(
23-
code: FunctionsErrorCodeCore, message?: string,
22+
constructor(code: FunctionsErrorCodeCore, message?: string,
2423
details?: unknown);
2524
readonly details?: unknown;
2625
}

docs-devsite/functions.functionserror.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,22 @@ export declare class FunctionsError extends FirebaseError
2525
2626
| Constructor | Modifiers | Description |
2727
| --- | --- | --- |
28-
| [(constructor)(code, message, details)](./functions.functionserror.md#functionserrorconstructor) | | Constructs a new instance of the <code>FunctionsError</code> class |
28+
| [(constructor)(code, message, details)](./functions.functionserror.md#functionserrorconstructor) | | Constructs a new instance of the <code>FunctionsError</code> class. |
2929
3030
## Properties
3131
3232
| Property | Modifiers | Type | Description |
3333
| --- | --- | --- | --- |
34-
| [details](./functions.functionserror.md#functionserrordetails) | | unknown | Extra data to be converted to JSON and included in the error response. |
34+
| [details](./functions.functionserror.md#functionserrordetails) | | unknown | Additional details to be converted to JSON and included in the error response. |
3535
3636
## FunctionsError.(constructor)
3737
38-
Constructs a new instance of the `FunctionsError` class
38+
Constructs a new instance of the `FunctionsError` class.
3939
4040
<b>Signature:</b>
4141
4242
```typescript
43-
constructor(
44-
code: FunctionsErrorCode, message?: string,
43+
constructor(code: FunctionsErrorCode, message?: string,
4544
details?: unknown);
4645
```
4746
@@ -55,7 +54,7 @@ constructor(
5554
5655
## FunctionsError.details
5756
58-
Extra data to be converted to JSON and included in the error response.
57+
Additional details to be converted to JSON and included in the error response.
5958
6059
<b>Signature:</b>
6160

packages/functions/src/error.ts

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,18 @@ const errorCodeMap: { [name: string]: FunctionsErrorCode } = {
5656
* @public
5757
*/
5858
export class FunctionsError extends FirebaseError {
59+
/**
60+
* Constructs a new instance of the `FunctionsError` class.
61+
*/
5962
constructor(
6063
/**
61-
* A standard error code that will be returned to the client. This also
62-
* determines the HTTP status code of the response, as defined in code.proto.
63-
*/
64+
* A standard error code that will be returned to the client. This also
65+
* determines the HTTP status code of the response, as defined in code.proto.
66+
*/
6467
code: FunctionsErrorCode,
6568
message?: string,
6669
/**
67-
* Extra data to be converted to JSON and included in the error response.
70+
* Additional details to be converted to JSON and included in the error response.
6871
*/
6972
readonly details?: unknown
7073
) {

0 commit comments

Comments
 (0)