From 7a87f2e633d9aeac5b0a06e882eebc86170cdee1 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 2 Apr 2026 10:28:54 +0100 Subject: [PATCH] ax(node): replace prose comments with usage examples in protocol.go MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ValidateResponse, ParseResponse, and GetProtocolErrorCode had comments that restated the function signature in prose — violating AX Principle 2 which requires comments to show concrete call-site usage, not descriptions. Co-Authored-By: Charon --- pkg/node/protocol.go | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/pkg/node/protocol.go b/pkg/node/protocol.go index 8958f0d..06d26b9 100644 --- a/pkg/node/protocol.go +++ b/pkg/node/protocol.go @@ -60,12 +60,13 @@ func (h *ResponseHandler) ParseResponse(resp *Message, expectedType MessageType, // DefaultResponseHandler is the default response handler instance. var DefaultResponseHandler = &ResponseHandler{} -// ValidateResponse is a convenience function using the default handler. +// if err := ValidateResponse(resp, MsgPong); err != nil { return 0, err } func ValidateResponse(resp *Message, expectedType MessageType) error { return DefaultResponseHandler.ValidateResponse(resp, expectedType) } -// ParseResponse is a convenience function using the default handler. +// var stats StatsPayload +// if err := ParseResponse(resp, MsgStats, &stats); err != nil { return nil, err } func ParseResponse(resp *Message, expectedType MessageType, target interface{}) error { return DefaultResponseHandler.ParseResponse(resp, expectedType, target) } @@ -76,7 +77,7 @@ func IsProtocolError(err error) bool { return ok } -// GetProtocolErrorCode returns the error code if err is a ProtocolError, otherwise returns 0. +// code := GetProtocolErrorCode(err) // 0 when err is not a ProtocolError func GetProtocolErrorCode(err error) int { if pe, ok := err.(*ProtocolError); ok { return pe.Code