Repository navigation
Keep single-item tuple variants when upgrading from v1 - #188
Merged
Merged
Conversation
This file contains hidden or 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.
This PR corrects the upgrade guidance for v1 tuple variants holding a single item. The current guidance says upgrades should unwrap them into their item, except for structs, tuples and links. Instead, upgrades should keep them as tuples:
This keeps the upgrade a faithful translation of the v1 IDL and leaves generated APIs unchanged. Authors can then simplify these variants to
{ data: integerTypeNode('u64') }themselves, and renderers can unwrap them before rendering if they wish.Since the stable 2.0.0 changelog is built from the pre-release changesets, the correction amends the existing enum variant changeset in
.changeset/pre/rather than adding a new one. The stable changelog therefore states the correct guidance once. Its upgrade example is updated to keep the tuple too.