Rename token::Interface/Client to TokenInterface/Client #1149
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
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.
What
Rename token::Interface/Client to TokenInterface/Client.
Why
When I've used the token::Interface it ends up with less than readable code because I end up with this generic "Interface" identifier in my code. If other interfaces follow suit it gets even worse when implementing multiple interfaces.
The rename happens in a backwards compatible way. The types are reexported as their old names, and the old names are hidden from docs, and have deprecated notices. The deprecated notice informs a developer what they need to change to update to the change. The hidden doc is helpful for the upcoming release that will be a first release and would be odd to display deprecated fns in the docs given any fns were release candidates anyway and the deprecated notice is a courtesy and convenience.