Description
TypeScript provides type safety, but it doesn't explain intent. Complex math functions (like yield calculation) or custom React hooks need inline documentation for IDE autocomplete to be useful.
Acceptance Criteria
Technical Details
- Configure ESLint (
eslint-plugin-jsdoc) to enforce JSDoc comments on newly created utility functions going forward.
Description
TypeScript provides type safety, but it doesn't explain intent. Complex math functions (like yield calculation) or custom React hooks need inline documentation for IDE autocomplete to be useful.
Acceptance Criteria
lib/utils/andhooks/directories./** ... */above every exported function.@paraminputs and the expected@returnsoutput.@throws.Technical Details
eslint-plugin-jsdoc) to enforce JSDoc comments on newly created utility functions going forward.