Giters

vdaas / vald

Vald. A Highly Scalable Distributed Vector Search Engine

Home Page:https://vald.vdaas.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Refactor] Create doc.go for each package

vankichi opened this issue · comments

commented

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/vald@v1.6.3/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/vald@v1.6.3/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