chore: minor corrections (documentation and comments)

mesh/client.go

@@ -309,11 +309,11 @@ func (m *Mesh) Rtt() {
 	// RTT without handshake
 	rtt := rttEnd.Sub(rttStart)
 
-	// safe metrics
+	// save metrics
 	m.metrics.GetRtt().WithLabelValues(data.SampleName[data.RTT_TOTAL], node.Name).Observe(rttH.Seconds())
 	m.metrics.GetRtt().WithLabelValues(data.SampleName[data.RTT_REQUEST], node.Name).Observe(rtt.Seconds())
 
-	// safe samples
+	// save samples
 	m.database.SetSample(
 		&data.Sample{
 			From:  m.setupConfig.Name,

mesh/mesh.go

@@ -36,7 +36,7 @@ import (
 	"go.uber.org/zap"
 )
 
-// Main struct for the mesh
+// Mesh is the internal mesh representation
 type Mesh struct {
 	// Mesh in-memory datastore
 	database data.Database
@@ -70,13 +70,13 @@ type Mesh struct {
 	joinRoutineDone    bool
 }
 
-// A newly discoverd node in the mesh
+// NodeDiscovered represents a newly discovered node in the mesh
 type NodeDiscovered struct {
 	NewNode *meshv1.Node
 	From    uint32 // TODO change to name
 }
 
-// Create a canary bot & mesh with the desired configuration
+// CreateCanaryMesh creates a canary bot & mesh with the desired configuration
 // Use a pre-defined routineConfig with e.g. StandardProductionRoutineConfig()
 // and define your mesh setup configuration
 //

mesh/server.go

@@ -40,7 +40,7 @@ import (
 	grpc_zap "github.com/grpc-ecosystem/go-grpc-middleware/logging/zap"
 )
 
-// Mesh server for incomming requests
+// MeshServer for incoming requests
 type MeshServer struct {
 	meshv1.UnimplementedMeshServiceServer
 	metrics metric.Metrics
@@ -51,7 +51,7 @@ type MeshServer struct {
 	newNodeDiscovered chan NodeDiscovered
 }
 
-// RPC if node wants to join the mesh
+// JoinMesh allows a node to join the mesh
 func (s *MeshServer) JoinMesh(ctx context.Context, req *meshv1.Node) (*meshv1.JoinMeshResponse, error) {
 	s.log.Infow("New join mesh request", "node", req.Name)
 	// Check if name of joining node is unique in mesh, let join if state is not ok, let join if target is same