chore: minor improvement for docs

pkg/cmd/run_node.go

@@ -28,7 +28,7 @@ import (
 	"github.com/evstack/ev-node/pkg/telemetry"
 )
 
-// ParseConfig is a helper that loads the node configuration and validates it.
+// ParseConfig is a helper function that loads the node configuration and validates it.
 func ParseConfig(cmd *cobra.Command) (rollconf.Config, error) {
 	nodeConfig, err := rollconf.Load(cmd)
 	if err != nil {

pkg/raft/election_test.go

@@ -444,7 +444,7 @@ func TestDynamicLeaderElectionRun(t *testing.T) {
 	}
 }
 
-// Helper to quickly build a Config with very short timeouts for tests
+// testCfg is a helper to quickly build a Config with very short timeouts for tests.
 func testCfg() Config {
 	return Config{SendTimeout: 2 * time.Millisecond}
 }

pkg/rpc/server/tracing.go

@@ -214,7 +214,7 @@ func (t *tracedP2PServer) GetNetInfo(
 	return res, nil
 }
 
-// tracedConfigServer decorates a ConfigServiceHandler with OpenTelemetry spans.
+// tracedConfigServer decorates the config service handler with OpenTelemetry spans.
 type tracedConfigServer struct {
 	inner  v1connect.ConfigServiceHandler
 	tracer trace.Tracer

pkg/sequencers/single/queue.go

@@ -465,7 +465,7 @@ func (bq *BatchQueue) Load(ctx context.Context) error {
 	var legacyItems []queuedItem
 	for result := range results.Next() {
 		if result.Error != nil {
-			// a datastore read failure means the WAL cannot be trusted as
+			// A datastore read failure means the WAL cannot be trusted as
 			// loaded — fail startup rather than silently dropping txs.
 			return fmt.Errorf("failed to read WAL entry from datastore: %w", result.Error)
 		}

pkg/service/baseservice_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/rs/zerolog"
 )
 
-// dummyService is a simple implementation of the Service interface for testing purposes.
+// dummyService is a simple implementation of Service for testing purposes.
 type dummyService struct {
 	*BaseService
 	runCalled bool