From f59e6f3050d367b256cb6e13406a63c529d9fcbe Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 2 Apr 2026 10:32:13 +0100 Subject: [PATCH] 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 --- pkg/mining/container.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pkg/mining/container.go b/pkg/mining/container.go index 4991156..1fb6103 100644 --- a/pkg/mining/container.go +++ b/pkg/mining/container.go @@ -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{