Discussion: How to document curried functions using TSDoc
Open
Nobody has claimed this yet.
general discussion
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Does tsdoc support curried functions? Is there an example how a curried function can be documented?
Related tickets: https://github.com/jsdoc/jsdoc/issues/1286 https://github.com/TypeStrong/typedoc/issues/1098
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 reviewing the question about whether TSDoc supports curried functions and the linked JSDoc and TypeDoc tickets. Determine whether the outcome should be an example, a clarified specification, or another documentation change; done means the supported approach and an example are documented or the scope is resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100