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.

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

Improve usage examples in README #11

Merged
merged 1 commit into from
Feb 14, 2017
Merged

Improve usage examples in README #11

merged 1 commit into from
Feb 14, 2017

Conversation

jhermsmeier
Copy link
Contributor

@jhermsmeier jhermsmeier commented Feb 14, 2017

Connects to #10

@jhermsmeier jhermsmeier force-pushed the update-readme branch 2 times, most recently from 24f0bb0 to 7b6ebbc Compare February 14, 2017 11:41
@jviotti
Copy link

jviotti commented Feb 14, 2017

Looks good, and I'll approve, however I wonder if we should be auto-generating this from JSDoc annotations instead.

@jhermsmeier
Copy link
Contributor Author

jhermsmeier commented Feb 14, 2017

however I wonder if we should be auto-generating this from JSDoc annotations instead.

That would of course be preferable, but would make it more complicated to show off things like verification (as it's not a method, and thus doesn't have docs associated), and also splitting the quite noisy API docs from these examples. Or is there a beautifully easy way of doing this?

@jviotti
Copy link

jviotti commented Feb 14, 2017

I believe you can include module-scope examples, while also provide some docs for the methods/properties, but definitely not high priority for now. We can experiment with it after v1.

@jhermsmeier
Copy link
Contributor Author

Aye, sounds good.

@jhermsmeier jhermsmeier merged commit d50be95 into master Feb 14, 2017
@jhermsmeier jhermsmeier deleted the update-readme branch February 14, 2017 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants