ax(mining): replace prose comment on DefaultContainerConfig with usage example

AX principle 2: comments show HOW with real values, not what the
signature already says. The old comment restated the function name.

Co-Authored-By: Charon <charon@lethean.io>
This commit is contained in:
Claude 2026-04-02 10:32:13 +01:00
parent d9f45773b4
commit f59e6f3050
No known key found for this signature in database
GPG key ID: AF404715446AEB41

View file

@ -27,7 +27,9 @@ type ContainerConfig struct {
SimulationMode bool
}
// DefaultContainerConfig returns sensible defaults for the container.
// cfg := mining.DefaultContainerConfig()
// cfg.ListenAddr = ":8080"
// c := NewContainer(cfg)
func DefaultContainerConfig() ContainerConfig {
return ContainerConfig{
Database: database.Config{