From f18991470d6586c7fbcafcbfdf4456b807d57bc1 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 2 Apr 2026 09:28:02 +0100 Subject: [PATCH] ax(node): replace prose comments with usage examples on Controller MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Controller type and sendRequest had comments that restated the type signature in prose. RFC-025 ยง2: if a comment restates what the type signature says, delete it; show a concrete call instead. Co-Authored-By: Charon --- pkg/node/controller.go | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/pkg/node/controller.go b/pkg/node/controller.go index 1e7f7a7..96dee5b 100644 --- a/pkg/node/controller.go +++ b/pkg/node/controller.go @@ -10,7 +10,9 @@ import ( "forge.lthn.ai/Snider/Mining/pkg/logging" ) -// Controller manages remote peer operations from a controller node. +// ctrl := node.NewController(nodeManager, peerRegistry, transport) +// rtt, _ := ctrl.PingPeer("abc123def456") +// stats, _ := ctrl.GetRemoteStats("abc123def456") type Controller struct { node *NodeManager peers *PeerRegistry @@ -59,7 +61,8 @@ func (c *Controller) handleResponse(conn *PeerConnection, msg *Message) { } } -// sendRequest sends a message and waits for a response. +// resp, err := c.sendRequest("abc123def456", msg, 10*time.Second) +// if err != nil { return nil, err } func (c *Controller) sendRequest(peerID string, msg *Message, timeout time.Duration) (*Message, error) { actualPeerID := peerID