Skip to content

Latest commit

 

History

History
8 lines (5 loc) · 459 Bytes

File metadata and controls

8 lines (5 loc) · 459 Bytes

Contributing

JSDoc comments

Every exported function in src/ carries a JSDoc comment (/** … */). These render in VSCode (and any TypeScript-aware editor) as hover documentation when the function is imported — no extra tooling required.

When adding a new function, follow the same pattern: one JSDoc block directly above the declaration describing what the function does, its parameters where non-obvious, and its return value or thrown errors.