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

Add comments to public structs, methods, functions, and packages #27

Open
t0rr3sp3dr0 opened this issue Jan 20, 2022 · 1 comment
Open

Add comments to public structs, methods, functions, and packages #27

t0rr3sp3dr0 opened this issue Jan 20, 2022 · 1 comment

Comments

@t0rr3sp3dr0
Copy link

Currently, the library has no godoc-compatible comments. The generated documentation contains nothing but the struct definitions and signature for public functions: https://pkg.go.dev/repo.incognia.com/go/incognia.

Add comments to the code so we can have a good documentation of the library.
@t0rr3sp3dr0
Copy link
Author

Reference: https://github.com/golang/go/wiki/CodeReviewComments#doc-comments

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
@t0rr3sp3dr0