You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Why
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.
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.
Summary
bun.DBandbun.SelectQueryshow empty documentation blocks on pkg.go.dev.Why
Proposal
db.go,query_select.go, andquery_insert.go.Happy to adjust scope or process (e.g., batch vs. incremental PRs) depending on maintainer preference.