docs: add JSDoc for some exports @W-13278716 #4014
Merged
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
It has no top-level exports, easy!
ekashida
reviewed
Feb 26, 2024
| @@ -85,6 +93,13 @@ export function generateCompilerError( | |||
| return error; | |||
| } | |||
|
|
|||
| /** | |||
| * Validates that the provided condition is truthy. | |||
There was a problem hiding this comment.
Suggested change
| * Validates that the provided condition is truthy. | |
| * Validates that the provided condition is true. |
There was a problem hiding this comment.
The function checks for truthiness, not for === true, so I think "truthy"/"falsy" are more accurate here.
There was a problem hiding this comment.
That's fine, I just saw that the type was boolean so we would only get either true or false
| * @param condition Condition to check. | ||
| * @param errorInfo The object holding the error metadata. | ||
| * @param args Values used to fill the error message template. | ||
| * @throws Throws a compiler error if the provided condition is falsy. |
There was a problem hiding this comment.
Suggested change
| * @throws Throws a compiler error if the provided condition is falsy. | |
| * @throws Throws a compiler error if the provided condition is false. |
Co-authored-by: Eugene Kashida <[email protected]>
ekashida
added a commit
that referenced
this pull request
Mar 3, 2024
* chore: add temp file for tracking all exports * docs(shared): add jsdoc for language features * chore: missed an export * docs(exports): add jsdoc for @lwc/shared language features * style: add eslint-plugin-jsdoc * chore: eslint-plugin-jsdoc auto fixes * chore(linter): manual fixes for jsdoc rules * chore: simplify env config for test files * style(jsdoc): enforce documenting yields * docs: include @param in all jsdocs, but not descriptions (yet) * docs(exports): fully document all @lwc/shared language features * chore: remove temp file * chore: lint JSDoc in @lwc/shared * chore(eslint): suppress unimportant warnings * docs(rollup-plugin): add jsdoc for main export * fix: use JSDoc comment instead of plain multiline * docs(babel-plugin-component): polish JSDoc for main plugin export * chore: mark progress in .eslintrc * docs(wire-service): polish JSDoc for `register` * docs(errors): add JSDoc for @lwc/errors * docs(errors): polish JSDoc for @lwc/features * chore: mark @lwc/style-compiler as documented It has no top-level exports, easy! * docs(template-compiler): add bad JSDoc for top-level exports * chore(jsdoc): comment block is not jsdoc * chore: revert jsdoc changes to 3rd party files * chore(eslint): enforce stricter JSDoc rules * docs: improve JSDoc in root scripts * chore(eslint): auto-fixes for new JSDoc rules * chore(eslint): manual for new JSDoc rules * chore: fix bad merge * docs: manual JSDoc tweaks post-merge * docs(style-compiler): add JSDoc for top-level exports * chore: mark style-compiler as complete * docs(style-compiler): use correct name in README * revert: remove useless empty JSDoc * revert: don't JSDoc 3rd party * docs(module-resolver): add JSDoc for main export * revert: accidental JSDocification of __PURE__ annotations * Update packages/@lwc/errors/src/compiler/utils.ts Co-authored-by: Eugene Kashida <[email protected]> --------- Co-authored-by: Eugene Kashida <[email protected]>
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.
Details
This time, with actual things to read!
Does this pull request introduce a breaking change?
Does this pull request introduce an observable change?
GUS work item