.*: fix revive package-comments lint issues (#7574)

* .*: fix revive package-comments lint issues * add example names to package comment * improve grammer
grpc · Sep 3, 2024 · cd05c9e · cd05c9e
1 parent 00514a7
commit cd05c9e
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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 (
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ @@
      *
      */
+    // Binary client is a client for the CSM Observability example.
     package main
     import (
@@ Expand Down @@