Fix description memoization in bundle schema#1409
Merged
shreyas-goenka merged 3 commits intomainfrom May 1, 2024
Merged
Conversation
shreyas-goenka
commented
Apr 30, 2024
| } | ||
| root = selfRef | ||
| root = &selfRef | ||
| root.Description = description |
Contributor
Author
There was a problem hiding this comment.
The location where we accidentally mutated the description stored in the memo.
andrewnester
approved these changes
May 1, 2024
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
2 participants
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.
Changes
Fixes #559
The CLI generation is now stable and does not produce a diff for the
bundle_descriptions.jsonfile.Before a pointer to the schema was stored in the memo, which would be mutated later to include the description. This lead to duplicate documentation for schema components that were used in multiple places. This PR fixes this issue.
Eg: Before all references of
pause_statuswould have the same description.Tests
Added regression test.