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

Use GoDoc #27

Open
nathanmsmith opened this issue Aug 26, 2019 · 0 comments
Open

Use GoDoc #27

nathanmsmith opened this issue Aug 26, 2019 · 0 comments

Comments

@nathanmsmith
Copy link

Currently, we document all our functions in the markdown of the README. I think it'd be nice and more idiomatic if we transferred most of this documentation over to GoDoc comments and linked to the godoc.org page for the bot.

That being said, I think it's still important to describe some basic functionalities and examples in the README, I just think the comprehensive documentation would make more sense in a medium better suited for it.
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
@nathanmsmith