dx: add missing godoc on all exported types and functions #234

New issue

Open

opened 2026-03-10 10:14:24 +00:00 by ash · 0 comments

ash commented

2026-03-10 10:14:24 +00:00

Owner

Problem

Several exported types and functions lack godoc comments:

conformance/ package — MemoryFactory, AccountState, AccountEvent, BalanceProjection, etc.
sqlitestore/ — WithUpcasters option
Various root package exports

Missing godoc means:

pkg.go.dev shows blank descriptions
IDE tooltips are empty
New users cannot understand the API without reading source

Solution

Audit all exported symbols across all packages. Every export gets a godoc comment following Go conventions:

Start with the name: // MemoryFactory returns a Factory that creates in-memory stores.
Explain purpose, not implementation
Include examples for complex types

Pillar: Developer Experience

## Problem Several exported types and functions lack godoc comments: - `conformance/` package — `MemoryFactory`, `AccountState`, `AccountEvent`, `BalanceProjection`, etc. - `sqlitestore/` — `WithUpcasters` option - Various root package exports Missing godoc means: - pkg.go.dev shows blank descriptions - IDE tooltips are empty - New users cannot understand the API without reading source ## Solution Audit all exported symbols across all packages. Every export gets a godoc comment following Go conventions: - Start with the name: `// MemoryFactory returns a Factory that creates in-memory stores.` - Explain purpose, not implementation - Include examples for complex types ## Pillar: Developer Experience