Make FunctionsError doc comment the same as the old interface

dlarocque · dlarocque · commit a5caf5126583 · 2024-10-03T11:49:02.000-04:00
diff --git a/packages/functions/src/error.ts b/packages/functions/src/error.ts
@@ -49,8 +49,7 @@ const errorCodeMap: { [name: string]: FunctionsErrorCode } = {
 };
 
 /**
- * An explicit error that can be thrown from a handler to send an error to the
- * client that called the function.
+ * An error returned by the Firebase Functions client SDK.
  *
  * See {@link FunctionsErrorCode} for full documentation of codes.
  *

Original file line number	Diff line number	Diff line change
`@@ -49,8 +49,7 @@ const errorCodeMap: { [name: string]: FunctionsErrorCode } = {`
`49`	`49`	`};`
`50`	`50`
`51`	`51`	`/**`
`52`		`- * An explicit error that can be thrown from a handler to send an error to the`
`53`		`- * client that called the function.`
	`52`	`+ * An error returned by the Firebase Functions client SDK.`
`54`	`53`	`*`
`55`	`54`	`* See {@link FunctionsErrorCode} for full documentation of codes.`
`56`	`55`	`*`