Simplify example code in comment and use more consistent naming

Gudahtt · Gudahtt · commit 06c5ef3e7d2b · 2025-10-24T16:17:23.000-02:30
diff --git a/packages/error-reporting-service/src/error-reporting-service.ts b/packages/error-reporting-service/src/error-reporting-service.ts
@@ -95,25 +95,25 @@ type ErrorReportingServiceOptions = {
  * import { ErrorReportingService } from '@metamask/error-reporting-service';
  * import { ExampleController } from './example-controller';
  *
- * type AllActions = MessengerActions<ErrorReportingServiceMessenger>;
- *
- * type AllEvents = MessengerEvents<ErrorReportingServiceMessenger>;
- *
- * type RootMessenger = Messenger<'Root', AllActions, AllEvents>;
+ * type RootMessenger = Messenger<
+ *   'Root',
+ *   MessengerActions<ErrorReportingServiceMessenger>,
+ *   MessengerEvents<ErrorReportingServiceMessenger>
+ * >;
  *
- * // Create a global messenger.
- * const globalMessenger = new Messenger();
+ * // Create a root messenger.
+ * const rootMessenger = new Messenger();
  *
  * // Register handler for the `ErrorReportingService:captureException`
- * // action in the global messenger.
+ * // action in the root messenger.
  * const errorReportingServiceMessenger = new Messenger<
  *   'ErrorReportingService',
  *   MessengerActions<ErrorReportingServiceMessenger>,
  *   MessengerEvents<ErrorReportingServiceMessenger>,
  *   RootMessenger
  * >({
  *   namespace: 'ErrorReportingService',
- *   parent: globalMessenger,
+ *   parent: rootMessenger,
  * });
  * const errorReportingService = new ErrorReportingService({
  *   messenger: errorReportingServiceMessenger,
@@ -127,9 +127,9 @@ type ErrorReportingServiceOptions = {
  *  RootMessenger
  * >({
  *   namespace: 'ExampleController',
- *   parent: globalMessenger,
+ *   parent: rootMessenger,
  * });
- * globalMessenger.delegate({
+ * rootMessenger.delegate({
  *   messenger: exampleControllerMessenger,
  *   actions: ['ErrorReportingService:captureException'],
  * });
