#442 documentation: Component prop types lack JSDoc comments — unclear what inputs do - #561
Conversation
|
Someone is attempting to deploy a commit to the David Dada's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
@simisann1 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
sshdopey
left a comment
There was a problem hiding this comment.
This is a thorough and thoughtful documentation PR! Adding JSDoc to all those prop interfaces really helps developers understand the components at a glance. I also appreciate you fixing the CSS syntax errors and the optional chaining issues along the way. The effort is clear and the changes are well-aligned with the issue. Great work! ❤️
|
Approved! 🎉 I couldn't auto-merge this just yet (it may need a rebase or have a check still running). A maintainer can merge it whenever it's ready. |
sshdopey
left a comment
There was a problem hiding this comment.
Thank you for this thorough documentation pass! Adding JSDoc comments to all those prop interfaces is exactly what #442 asked for, and it will make the components much easier to use. I also appreciate you fixing the inline style syntax issues along the way. The changes look clean and well-organized. Great work! ❤️
|
Approved! 🎉 I couldn't auto-merge this just yet (it may need a rebase or have a check still running). A maintainer can merge it whenever it's ready. |
PR: #442 documentation: Component prop types lack JSDoc comments — unclear what inputs do
Summary
Adds complete JSDoc documentation to all component prop interfaces across the repository (#442). Previously, components such as
ProjectCard(InvestmentCard),Card,AmountInput,ScoreGauge,StatBlock,LiquidityMeter,FormField,Badge,Tag, and others lacked prop-level documentation, forcing developers to read component source code to understand available options, defaults, and input behavior.This change adds explicit, clear JSDoc comments to 100% of properties across 20 component prop interfaces (106 documented props in total). Hover tooltips and IDE autocompletion now immediately display parameter descriptions, default values, units, and expected usage. Additionally, pre-existing inline CSS
styleprop syntax errors and optional chaining anomalies were resolved inCard.tsx,ProjectCard.tsx, andAmountInput.tsx.Linked issue
#442
Type of change
Screenshots / screencast
N/A — Developer documentation and TypeScript type hover enhancements only.
Checklist
Closes #442)Closes #442