Skip to content

Document each field in output object #18

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
Closed
jfirebaugh opened this issue Mar 11, 2015 · 2 comments
Closed

Document each field in output object #18

jfirebaugh opened this issue Mar 11, 2015 · 2 comments
Labels
help wanted

Comments

@jfirebaugh
Copy link
Member

No description provided.

@tmcw tmcw mentioned this issue May 20, 2015
Closed
@jfirebaugh
Copy link
Member Author

We should JSDoc a Comment class / typedef and use it everywhere we're currently using plain Object.

This was referenced Mar 13, 2016
Closed
Closed
@jfirebaugh
Copy link
Member Author

https://github.com/documentationjs/documentation-schema/blob/master/index.js

rhendric pushed a commit to rhendric/documentation that referenced this issue Sep 15, 2022
@hdgarrood
Update kinds, add newer syntaxes, notes (documentationjs#75)
a15f4e6 
* Update kinds

* Pattern guards

* Nested records

Fixes documentationjs#18. Todo: Unify with Records.md?

* Expand section on type synonyms

The example involving `one` did not type check. Now it does. Maybe it would be helpful to think of real-world examples for type synonyms and use those here intead of another example involving Foo & Bar.

* Notes that I would find helpful

* Do something with the bound variable

* Misc. formatting

* Typo, hopefully a bit clearer

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

No branches or pull requests
2 participants
@tmcw @jfirebaugh