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

Enhanced documentation for each package #52

Closed
peterbourgon opened this issue May 27, 2015 · 3 comments
Closed

Enhanced documentation for each package #52

peterbourgon opened this issue May 27, 2015 · 3 comments
Assignees

Comments

@peterbourgon
Copy link
Member

  • Investigate using davecheney/godoc2md to produce READMEs for each package, including only the package summaries, not the full API. This may require adapting the tool.
  • Finish the rationale sections.
  • Add proper example functions to illustrate usage, rather than excerpts in the READMEs.
@harlow
Copy link
Contributor

harlow commented May 27, 2015

@peterbourgon do you think its worth creating an example README by hand first? Something we can all agree on and then seeing how we can use computers to re-generate it?

I like the idea of having examples that are verified by the test suite. This should help reduce the chances of README drift.

@peterbourgon
Copy link
Member Author

I'd rather tackle it from the other angle: see what the tools can do, and then tweak it as necessary. I honestly don't care about many of the details, as long as we have a package overview, a rationale, and links to the example_xxx.go examples.

@peterbourgon
Copy link
Member Author

I've pushed an overhaul to the documentation, focusing heavily on examples. Still some rough edges to smooth out, e.g. #107, but this can be considered done, I think.

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

No branches or pull requests

2 participants