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

Create godoc #3

Open

2 tasks

Gamma169 opened this issue Jan 16, 2022 · 3 comments

Owner

Gamma169 commented Jan 16, 2022 •

edited

Loading

README was written out in #5 .

A Godoc would be extremely useful so that someone who wants to use the library doesn't have to look at source code or examples.

There are two parts to this:

Generate Basic Godoc outlining all the functions available in the package
Write documentation around every (or most) of the functions, and give examples.

Gamma169 changed the title ~~Flesh Out README~~ Create godoc

Owner Author

Gamma169 commented Jan 17, 2022

This might be useful. Haven't read it too deeply yet.
https://go.dev/blog/godoc

Owner Author

Gamma169 commented Jan 17, 2022

Looks like it might have been automatically created?
https://pkg.go.dev/github.com/Gamma169/go-server-helpers

Need to look more into things to actually populate it.

Owner Author

Gamma169 commented Jan 17, 2022

Another article to look into
https://pkg.go.dev/about#best-practices-h2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment