chore(docs): Rename ControllerMessenger to Messenger
#5089
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Rename `ControllerMessenger` to `Messenger` in the controller docs. Relates to #4538
mcmire
reviewed
Jan 8, 2025
| @@ -121,7 +121,7 @@ type AllowedEvents = never; | |||
| * The messenger which is restricted to actions and events accessed by | |||
| * {@link GasPricesController}. | |||
| */ | |||
| export type GasPricesControllerMessenger = RestrictedControllerMessenger< | |||
| export type GasPricesMessenger = RestrictedMessenger< | |||
There was a problem hiding this comment.
Hmm, should we still call controller messengers <Name>ControllerMessenger? I know it is a mouthful to say, but it aligns with how we are naming other controller types (GasPricesControllerState, GasPricesControllerActions, etc.) (I guess we could call service messengers <Name>ServiceMessenger as well, provided that the service class itself is called <Name>Service?)
There was a problem hiding this comment.
Good question. We have examples of both conventions (e.g. NetworkState, PreferencesState).
I can update this to leave the names as they were before for now at least.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
Rename
ControllerMessengertoMessengerin the controller docs and examples.References
Relates to #4538
Changelog
N/A
Checklist