Request: Add GoDoc comments to exported API types/functions · uptrace/bun#1283

(1 comment) (0 reactions) (0 assignees)Go (4,826 stars) (279 forks)user submission

documentationgood first issuehelp wanted

説明

Most exported types and functions currently ship without GoDoc; for example, bun.DB and bun.SelectQuery show empty documentation blocks on pkg.go.dev.
As a production user, this makes it harder to understand intended semantics without diving into implementation or external docs.

IDEs and pkg.go.dev rely on GoDoc to surface quick info. Without it, new team members end up spelunking through the source or switching back and forth with https://bun.uptrace.dev/.
External docs help with guides, but inline API docs would clarify parameters, return values, and gotchas at the call site.

Confirm there is no policy against GoDoc in this repo. (I did not find an issue explaining one; closest is the documentation request in #1145 which was closed as stale.)
If maintainers agree, I can start opening PRs that add succinct GoDoc comments to exported symbols, beginning with core files like db.go, query_select.go, and query_insert.go.
Keep comments focused on API intent, optionally linking to the official docs for deeper dives to avoid duplication.

Happy to adjust scope or process (e.g., batch vs. incremental PRs) depending on maintainer preference.

技術スタック: go
領域: backenddocumentation
Issue 種別: documentation
難度: 2
推定時間: half day
活動状況: fresh
明確さ: clear
前提条件: Basic Go knowledgeFamiliarity with GoDoc syntax
初心者向け度: 80
調査方針: This issue proposes adding GoDoc comments to exported types and functions in the uptrace/bun repository. The key files to target are db.go, query select.go, and query insert.go as mentioned in the issue body. First, confirm with maintainers that there is no policy against GoDoc (the issue requests this). Then, examine existing exported symbols in those files and add succinct GoDoc comments describing their purpose, parameters, and return values. Keep comments focused on API intent and optionally link to official documentation. The issue has a single comment from the author, and no other discussion or linked PRs, so it is available for contribution.