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.js and 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-jsdoc on their GitHub repo about this. Hopefully there's a solution to this or a new ESLint rule could be included for that.
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