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

[Refactor] Create doc.go for each package #1826

Open
vankichi opened this issue Oct 28, 2022 · 0 comments
Open

[Refactor] Create doc.go for each package #1826

vankichi opened this issue Oct 28, 2022 · 0 comments

Comments

@vankichi
Copy link
Contributor

Describe the bug:

In the Vald project, almost packages have no doc.go.
It affects displaying on the pkg.go.dev, e.g. https://pkg.go.dev/github.com/vdaas/[email protected]/internal/compress .

To Reproduce:

None (This problem does NOT affect the Vald)

Expected behavior:

Displaying correct state like as https://pkg.go.dev/github.com/vdaas/[email protected]/internal/errgroup
We can fix it:

  1. Add doc.go for each package
  2. Remove the overview comment from each file except doc.go

Environment:

  • Go Version: 1.19.2
  • Docker Version: 20.10.8
  • Kubernetes Version: 1.22.0
  • NGT Version: 1.14.8
@vankichi vankichi changed the title Create doc.go for each packages Create doc.go for each package Oct 28, 2022
@vankichi vankichi changed the title Create doc.go for each package [Refactor] Create doc.go for each package Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant