chore(jsdoc): add jsdoc to parts of logging system#3180
Merged
rwaskiewicz merged 3 commits intomainfrom Jan 4, 2022
Merged
Conversation
this commit adds JSDoc to a portion of Stencil's logging infrastructure. it was motivated by a spike wherein investigating adding error codes to the compiler were explored. this work is recovered from that effort, to help aid in understanability of this portion of the codebase. some methods have been renamed to better reflect their intent. some usages of `var` have been converted to `let`, as usage of the variable defined using `var` did not appear to need to be declared using the keyword
ltm
approved these changes
Jan 4, 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?
There is no JSDoc for our logging infra
GitHub Issue Number: N/A
What is the new behavior?
this commit adds JSDoc to a portion of Stencil's logging infrastructure.
it was motivated by a spike wherein investigating adding error codes to
the compiler were explored. this work is recovered from that effort, to
help aid in understanability of this portion of the codebase.
some methods have been renamed to better reflect their intent.
some usages of
varhave been converted tolet, as usage of thevariable defined using
vardid not appear to need to be declared usingthe keyword
Does this introduce a breaking change?
Testing
N/A, although I was actively using this system with the intent of getting error messages out