fix(generators): Improve consistency of migrated language generators #7662
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
And improve its documentation too. Fix the @returns doc for PythonGenerator's getAdjustedInt but (for now) don't change the type because it does actually return numbers in some circumstances.
maribethb
approved these changes
Nov 21, 2023
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.
The basics
The details
Resolves
Fixes minor consistency and style issues in the previously-migrated generators.
Proposed Changes
@fileoverviewwith@filein a number of places.@suppressdirectives.getAdjustedonDartGeneratorandJavascriptGeneratortostring(and improve the@returnsJSDoc), for consistency with changes made toPhpGeneratorin refactor(generators): Migrate PHP generators to TypeScript #7647. It was previouslystring | number, but after applying required casts no numbers are now ever returned.Reason for Changes
Consistency and cruft removal.
Additional Info
The change to the return type of
getAdjustedis technically a breaking change, as external developers could have replaced our version with one that actually does return numbers, but the signature change itself is not treated as breaking since the generators have heretofore all been declared asanyand we decided not to treat fixing the declarations as being a breaking change.