Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

Browse source 
AX Principle 2 — comments show HOW with real values, not WHAT the
signature already says. "NewService creates a new mining service"
restates the name; the usage example teaches call-site shape.

Co-Authored-By: Charon <charon@lethean.io>
This commit is contained in:
Claude 2026-04-02 12:53:21 +01:00
parent 222edcd070
commit bbbe474610
No known key found for this signature in database
GPG key ID: AF404715446AEB41
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
pkg/mining/service.go
View file

@ -394,7 +394,7 @@ var wsUpgrader = websocket.Upgrader{
},
}
// NewService creates a new mining service
// svc, err := mining.NewService(mgr, ":9090", "localhost:9090", "api/v1/mining")
func NewService(manager ManagerInterface, listenAddr string, displayAddr string, swaggerNamespace string) (*Service, error) {
apiBasePath := "/" + strings.Trim(swaggerNamespace, "/")
swaggerUIPath := apiBasePath + "/swagger"