docs: improve docstring

dreamorosi · dreamorosi · commit 652a5c5455d5 · 2024-11-06T11:08:46.000+01:00
diff --git a/packages/metrics/src/types/Metrics.ts b/packages/metrics/src/types/Metrics.ts
@@ -66,7 +66,7 @@ type MetricsOptions = {
    * If not provided, debug messages will be suppressed, and warning and error messages will be sent to stdout.
    *
    * Note that EMF metrics are always sent directly to stdout, regardless of the logger
-   * to avoid any potential side effects from using a custom logger.
+   * to avoid compatibility issues with custom loggers.
    */
   logger?: GenericLogger;
 };

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ type MetricsOptions = {`
`66`	`66`	`* If not provided, debug messages will be suppressed, and warning and error messages will be sent to stdout.`
`67`	`67`	`*`
`68`	`68`	`* Note that EMF metrics are always sent directly to stdout, regardless of the logger`
`69`		`- * to avoid any potential side effects from using a custom logger.`
	`69`	`+ * to avoid compatibility issues with custom loggers.`
`70`	`70`	`*/`
`71`	`71`	`logger?: GenericLogger;`
`72`	`72`	`};`