Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add summary to method and function return types #32

Open
bennypowers opened this issue Dec 17, 2020 · 1 comment
Open

Add summary to method and function return types #32

bennypowers opened this issue Dec 17, 2020 · 1 comment

Comments

@bennypowers
Copy link
Contributor

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.
@bennypowers bennypowers mentioned this issue Dec 17, 2020
Closed
@bennypowers
Copy link
Contributor Author

See #33 for an example declaration and screenshot use case

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bennypowers