lambdaclass / lambdaclass/eth-agent
Missing JSDoc for public API functions
Open
Nobody has claimed this yet.
documentation
low-priority
- Dominant language
- TypeScript
- Stars
- 10
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Problem
Many exported functions lack comprehensive JSDoc documentation.
Recommendation
Add JSDoc with:
- Description
- Parameter documentation
- Return value documentation
- Usage examples
- Thrown errors
For all public exports in src/index.ts.
Priority
Low - Developer experience
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the public exports in src/index.ts and catalog the functions that lack JSDoc. Add descriptions, parameter and return documentation, usage examples, and thrown-error details for every public export; done means all public exports in that file are comprehensively documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100