-
-
Notifications
You must be signed in to change notification settings - Fork 200
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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).
docs/writing-controllers.md
Outdated
>(); | ||
const barControllerMessenger = rootMessenger.getRestricted({ | ||
const rootMessenger = new Messenger<'BarController:stateChange', never>(); | ||
const barMessenger = rootMessenger.getRestricted({ |
There was a problem hiding this comment.
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?
docs/writing-controllers.md
Outdated
@@ -790,7 +784,7 @@ export type AllowedEvents = | |||
| ApprovalControllerApprovalRequestApprovedEvent | |||
| ApprovalControllerApprovalRequestRejectedEvent; | |||
|
|||
export type SwapsControllerMessenger = RestrictedControllerMessenger< | |||
export type SwapsMessenger = RestrictedMessenger< |
There was a problem hiding this comment.
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)
Rename `ControllerMessenger` to `Messenger` in the controller docs. Relates to #4538
264544e
to
923da9b
Compare
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. |
Explanation
Rename
ControllerMessenger
toMessenger
in the controller docs and examples.References
Relates to #4538
Changelog
N/A
Checklist