Cleaning up existing JSDoc comments; Excluding props for typedefs #472
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
leekahung
requested review from
timbot1789,
xscottxbrownx and
Jared-Krajewski
leekahung
added
documentation
timbot1789
approved these changes
Oct 22, 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.
This PR:
Originally planned to fix Issue #471 with this PR, but the idea fell out when the solution failed to work. In the meantime, I've patched most of the JSDoc comments in the codebase in several locations.
This PR moves all component Props out of
typedefs.jsand having it closer to the component. This is done by having them defined directly in the JSDoc comment above the component.Future Steps/PRs Needed to Finish This Work (optional):
While this cleans up some of the JSDoc comments, the bug pointed out in Issue #471 remains. At this time, there isn't a ESLint rule in our existing configuration to pick up when a specific typedef is no longer in use in the file like that of a unused variable or module/library import. For that I'll be issuing a new issue for
eslint-plugin-jsdocon their GitHub repo about this. Hopefully there's a solution to this or a new ESLint rule could be included for that.Issues needing discussion/feedback (optional):
1. Issue #471