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

More examples #2

Open
h2non opened this issue Mar 21, 2016 · 2 comments
Open

More examples #2

h2non opened this issue Mar 21, 2016 · 2 comments
Labels
enhancement

Comments

@h2non
Copy link
Member

h2non commented Mar 21, 2016

No description provided.

@groyoh
Copy link
Member

groyoh commented Apr 2, 2016

What's the most idiomatic way to provide examples in Go repositories? In the README or via go's examples?

@h2non
Copy link
Member Author

h2non commented Apr 2, 2016

Some code examples at documentation level is fine, but just one or two cases to clarify the usage alongside the description. For more use cases I would write them as a Go file in the _examples folder. The example should be able to compile via go run and be a practical 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
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@h2non @groyoh