chore(jsdoc): document @Prop() parsing#3232
Merged
rwaskiewicz merged 2 commits intomainfrom Feb 7, 2022
Merged
Conversation
this commit adds jsdoc + explicit return types to a portion of the codebase that parses Stencil members that are decorated with @prop() it also includes a minor code change where a duplicated enum is removed from a bitwise calculation when determining whether or not a prop's type is of the type 'boolean' or not
ltm
approved these changes
Feb 7, 2022
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.
Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build) was run locally and any changes were pushednpm test) were run locally and passednpm run test.karma.prod) were run locally and passednpm run prettier) was run locally and passedPull request type
Please check the type of change your PR introduces:
What is the current behavior?
While doing an investigation surrounding prop behavior for union types (STENCIL-349), I took a little extra time to JSDoc some of the functions associated with prop parsing (although not all of them). The idea here was to "leave the forest a little nicer than you found it"
GitHub Issue Number: N/A
What is the new behavior?
this commit adds jsdoc + explicit return types to a portion of the
codebase that parses Stencil members that are decorated with @prop()
it also includes a minor code change where a duplicated enum is removed
from a bitwise calculation when determining whether or not a prop's type
is of the type 'boolean' or not
Does this introduce a breaking change?
Testing
N/A (I consider the JSDoc non-testable). I don't think there's any testing that can be done for the duplicated enum I removed from the bitwise calc, but LMK if you have any ideas.
Other information
Some items out of scope of the investigatory work I was doing have been TODO'ed in the codebase