From cd05c9e58fb9d6563e1c7d895f55faec763fc20e Mon Sep 17 00:00:00 2001 From: Purnesh Dixit Date: Tue, 3 Sep 2024 11:35:19 +0530 Subject: [PATCH] .*: fix revive package-comments lint issues (#7574) * .*: fix revive package-comments lint issues * add example names to package comment * improve grammer --- examples/features/csm_observability/client/main.go | 1 + examples/features/csm_observability/server/main.go | 1 + examples/features/customloadbalancer/client/main.go | 1 + examples/features/customloadbalancer/server/main.go | 1 + examples/features/opentelemetry/client/main.go | 1 + examples/features/opentelemetry/server/main.go | 1 + interop/observability/client/client.go | 5 +++++ interop/observability/server/server.go | 5 +++++ 8 files changed, 16 insertions(+) diff --git a/examples/features/csm_observability/client/main.go b/examples/features/csm_observability/client/main.go index c89676c1c..8ba1e863a 100644 --- a/examples/features/csm_observability/client/main.go +++ b/examples/features/csm_observability/client/main.go @@ -16,6 +16,7 @@ * */ +// Binary client is a client for the CSM Observability example. package main import ( diff --git a/examples/features/csm_observability/server/main.go b/examples/features/csm_observability/server/main.go index 399e00c5c..b87f859aa 100644 --- a/examples/features/csm_observability/server/main.go +++ b/examples/features/csm_observability/server/main.go @@ -16,6 +16,7 @@ * */ +// Binary server is a server for the CSM Observability example. package main import ( diff --git a/examples/features/customloadbalancer/client/main.go b/examples/features/customloadbalancer/client/main.go index 47497043e..02170029c 100644 --- a/examples/features/customloadbalancer/client/main.go +++ b/examples/features/customloadbalancer/client/main.go @@ -16,6 +16,7 @@ * */ +// Binary client is a client for the custom load balancer example. package main import ( diff --git a/examples/features/customloadbalancer/server/main.go b/examples/features/customloadbalancer/server/main.go index 5bcf2c591..9f2cb24e3 100644 --- a/examples/features/customloadbalancer/server/main.go +++ b/examples/features/customloadbalancer/server/main.go @@ -16,6 +16,7 @@ * */ +// Binary server is a server for the custom load balancer example. package main import ( diff --git a/examples/features/opentelemetry/client/main.go b/examples/features/opentelemetry/client/main.go index 4bc3d5afb..071d7ba63 100644 --- a/examples/features/opentelemetry/client/main.go +++ b/examples/features/opentelemetry/client/main.go @@ -16,6 +16,7 @@ * */ +// Binary client is a client for the OpenTelemetry example. package main import ( diff --git a/examples/features/opentelemetry/server/main.go b/examples/features/opentelemetry/server/main.go index 78fbf6bf3..2bda00809 100644 --- a/examples/features/opentelemetry/server/main.go +++ b/examples/features/opentelemetry/server/main.go @@ -16,6 +16,7 @@ * */ +// Binary server is a server for the OpenTelemetry example. package main import ( diff --git a/interop/observability/client/client.go b/interop/observability/client/client.go index 5478efdbe..0a07994bb 100644 --- a/interop/observability/client/client.go +++ b/interop/observability/client/client.go @@ -16,6 +16,11 @@ * */ +// Binary client is an interop client for Observability. +// +// See interop test case descriptions [here]. +// +// [here]: https://github.com/grpc/grpc/blob/master/doc/interop-test-descriptions.md package main import ( diff --git a/interop/observability/server/server.go b/interop/observability/server/server.go index 7efab04bb..06209947b 100644 --- a/interop/observability/server/server.go +++ b/interop/observability/server/server.go @@ -16,6 +16,11 @@ * */ +// Binary server is an interop server for Observability. +// +// See interop test case descriptions [here]. +// +// [here]: https://github.com/grpc/grpc/blob/master/doc/interop-test-descriptions.md package main import (