Skip to content

Commit c35327c

Browse files
authored
chore: fix inline doc errors related to profile metrics (#30191)
## **Description** The messenger init functions for the profile metrics controller and service erroneously stated they were for the accounts controller. These errors have been fixed. ## **Changelog** CHANGELOG entry: null ## **Related issues** N/A ## **Manual testing steps** N/A ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** <!-- Every checklist item must be consciously assessed before marking this PR as "Ready for review". A checked box means you deliberately considered that responsibility, not that you literally performed every action listed. Unchecked boxes are ambiguous: they are not an implicit "N/A" and they are not a silent "skip". See `docs/readme/ready-for-review.md` for the full checklist semantics. --> - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I've included tests if applicable - [x] I've documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I've applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. #### Performance checks (if applicable) - [ ] I've tested on Android - Ideally on a mid-range device; emulator is acceptable - [ ] I've tested with a power user scenario - Use these [power-user SRPs](https://consensyssoftware.atlassian.net/wiki/spaces/TL1/pages/edit-v2/401401446401?draftShareId=9d77e1e1-4bdc-4be1-9ebb-ccd916988d93) to import wallets with many accounts and tokens - [ ] I've instrumented key operations with Sentry traces for production performance metrics - See [`trace()`](/app/util/trace.ts) for usage and [`addToken`](/app/components/Views/AddAsset/components/AddCustomToken/AddCustomToken.tsx#L274) for an example For performance guidelines and tooling, see the [Performance Guide](https://consensyssoftware.atlassian.net/wiki/spaces/TL1/pages/400085549067/Performance+Guide+for+Engineers). ## **Pre-merge reviewer checklist** <!-- Reviewer checklist items follow the same semantics as the author checklist: an unchecked box is ambiguous, a checked box means the reviewer consciously assessed that responsibility. See `docs/readme/ready-for-review.md`. --> - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Comment-only changes that correct JSDoc descriptions for profile metrics messenger init helpers; no runtime behavior or API surface changes. > > **Overview** > Fixes incorrect inline documentation in `getProfileMetricsControllerMessenger` and `getProfileMetricsServiceMessenger`, updating JSDoc text that mistakenly referenced the *accounts controller* to correctly reference the *profile metrics controller/service*. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 3fd5622. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent 6caf9e6 commit c35327c

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

app/core/Engine/messengers/profile-metrics-controller-messenger.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ type ProfileMetricsControllerInitMessengerActions =
1616

1717
/**
1818
* Create a messenger restricted to the allowed actions and events of the
19-
* accounts controller.
19+
* profile metrics controller.
2020
*
2121
* @param messenger - The base messenger used to create the restricted
2222
* messenger.

app/core/Engine/messengers/profile-metrics-service-messenger.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ type AllowedEvents = MessengerEvents<ProfileMetricsServiceMessenger>;
1212

1313
/**
1414
* Create a messenger restricted to the allowed actions and events of the
15-
* accounts controller.
15+
* profile metrics service.
1616
*
1717
* @param messenger - The base messenger used to create the restricted
1818
* messenger.

0 commit comments

Comments
 (0)