describe-package: Better type representation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 23
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 17
Description
Adaptor docs doesn't currently show any type information on parameters (or return types, which may be less useful).
We need to a) extend describe-package to include good, human-readable descriptions of types, and b) render those types in adaptor-docs.
This gets particularly interesting with complex types, like objects.
I've started to add type analysis to describe-package but this issue is a reminder to take it further.
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 with the existing type analysis in describe-package and trace how its output is consumed by adaptor-docs. Extend the description so parameters and, where useful, return types have human-readable representations, including complex object types, then render those types in adaptor-docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100