ax(mining): replace prose comment with usage example on ContainerConfig
AX Principle 2: comments must show concrete usage, not restate the type name. Co-Authored-By: Charon <charon@lethean.io>
This commit is contained in:
parent
a10adc881b
commit
5d2917269b
1 changed files with 3 additions and 1 deletions
|
|
@ -9,7 +9,9 @@ import (
|
|||
"forge.lthn.ai/Snider/Mining/pkg/logging"
|
||||
)
|
||||
|
||||
// ContainerConfig holds configuration for the service container.
|
||||
// cfg := mining.DefaultContainerConfig()
|
||||
// cfg.ListenAddr = ":8080"
|
||||
// cfg.SimulationMode = true
|
||||
type ContainerConfig struct {
|
||||
// Database configuration
|
||||
Database database.Config
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue