webcomponents / webcomponents/custom-elements-manifest
Add summary to method and function return types
Open
- Dominant language
- TypeScript
- Stars
- 502
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
`Parameter` and other types have a markdown summary field which our user could populate with a table to represent a property bag.
It would be helpful to include that summary on the return type of functions and methods so that they can document the properties of return types.
This is an easy escape hatch for many typings-related issues and could be a good way to "thread the needle" of flexibility vs API pollution.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.