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

ax(node): replace prose comments with usage examples in transport and identity

Browse source 
AX Principle 2: comments must show HOW with real values, not restate what
the function name already says. Five prose descriptions replaced with
concrete call-site examples.

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

2
pkg/node/identity.go
View file

@ -275,7 +275,7 @@ func (manager *NodeManager) loadIdentity() error {
return nil
}
// Delete removes the node identity and keys from disk.
// if err := manager.Delete(); err != nil { return err } // removes key and config from disk; clears in-memory state
func (manager *NodeManager) Delete() error {
manager.mutex.Lock()
defer manager.mutex.Unlock()

8
pkg/node/transport.go
View file

@ -607,7 +607,7 @@ func (t *Transport) handleWSUpgrade(w http.ResponseWriter, r *http.Request) {
go t.keepalive(pc)
}
// performHandshake initiates handshake with a peer.
// if err := t.performHandshake(pc); err != nil { conn.Close(); return nil, err }
func (t *Transport) performHandshake(pc *PeerConnection) error {
// Set handshake timeout
handshakeTimeout := 10 * time.Second
@ -712,7 +712,7 @@ func (t *Transport) performHandshake(pc *PeerConnection) error {
return nil
}
// readLoop reads messages from a peer connection.
// go t.readLoop(pc) // started by Connect and handleWSUpgrade after handshake
func (t *Transport) readLoop(pc *PeerConnection) {
defer t.waitGroup.Done()
defer t.removeConnection(pc)
@ -781,7 +781,7 @@ func (t *Transport) readLoop(pc *PeerConnection) {
}
}
// keepalive sends periodic pings.
// go t.keepalive(pc) // started by Connect and handleWSUpgrade; pings every t.config.PingInterval
func (t *Transport) keepalive(pc *PeerConnection) {
defer t.waitGroup.Done()
@ -816,7 +816,7 @@ func (t *Transport) keepalive(pc *PeerConnection) {
}
}
// removeConnection removes and cleans up a connection.
// t.removeConnection(pc) // called from readLoop on error and keepalive on timeout
func (t *Transport) removeConnection(pc *PeerConnection) {
t.mutex.Lock()
delete(t.conns, pc.Peer.ID)