Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Rename ControllerMessenger to Messenger #5089

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Dec 20, 2024

Explanation

Rename ControllerMessenger to Messenger in the controller docs and examples.

References

Relates to #4538

Changelog

N/A

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@Gudahtt Gudahtt marked this pull request as ready for review December 20, 2024 06:04
Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I spotted more instances we may wish to revert in the docs. I guess it is not a huge deal, but it would be good not to mislead people accidentally if they're using the docs as examples (instead of the examples themselves).

>();
const barControllerMessenger = rootMessenger.getRestricted({
const rootMessenger = new Messenger<'BarController:stateChange', never>();
const barMessenger = rootMessenger.getRestricted({
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Do we want to stick with barControllerMessenger here so it matches real code?

@@ -790,7 +784,7 @@ export type AllowedEvents =
| ApprovalControllerApprovalRequestApprovedEvent
| ApprovalControllerApprovalRequestRejectedEvent;

export type SwapsControllerMessenger = RestrictedControllerMessenger<
export type SwapsMessenger = RestrictedMessenger<
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to continue using SwapsControllerMessenger here so it matches real code? (same for instances of GasFeeMessenger, TokensMessenger, etc. in this document)

@Gudahtt Gudahtt force-pushed the messenger-rename-docs branch from 264544e to 923da9b Compare January 9, 2025 22:36
@Gudahtt
Copy link
Member Author

Gudahtt commented Jan 9, 2025

Thanks, both good catches. I made the mistake of not self-reviewing after that last update. I've just checked the diff over and I think I've reverted all of the highlighted unnecessary variable renames now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants