Expand generic type names to be more descriptive #155
Merged
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
zephraph
force-pushed
the
expand-generic-types
branch
from
f21ffc7 to
389f091
Compare
zephraph
commented
Sep 12, 2020
| export { BreakpointKey } from "./Breakpoints" | ||
| export { BreakpointConstraint as BreakpointKey } from "./Breakpoints" |
There was a problem hiding this comment.
This is to avoid having breaking changes in the external API
zephraph
commented
Sep 12, 2020
Comment on lines
-17
to
+20
| export enum BreakpointKey { | ||
| export enum BreakpointConstraint { |
There was a problem hiding this comment.
While this is technically a breaking change for this module's api, it should only affect the internal API.
The external API is preserved via this change.
zephraph
changed the title
|
🚀 PR was released in |
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.
This is a quality of life refactor to ease understanding of what types represent what. It expends generic template names like
Bto be a more descriptiveBreakpointKey.There are a few particular places that deserve special attention which I'll call out in the changes.
Release Notes
This update expands the generic type names to be self descriptive instead of being single characters. While this change predominately only affects internal types the internal
BreakpointKeywas renamed toBreakpointConstraint. Give that that's not documented as part of our external API we haven't listed this release as a breaking change; however, if you use that import you will need to update your references.