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 doc.go for documentation #90

Open
RicYaben opened this issue Apr 25, 2023 · 0 comments
Open

Use doc.go for documentation #90

RicYaben opened this issue Apr 25, 2023 · 0 comments

Comments

@RicYaben
Copy link
Collaborator

RicYaben commented Apr 25, 2023 •
edited
Loading

We should use the format doc.go to add descriptions to packages. This approach can be seen in bigger projects (e.g. Kubernetes) that start to see the complexities of the Golang project layout, and the Golang documentation official page Godoc
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
@RicYaben