treewide: documentation on exported types should start with their name
Change-Id: I2e25157459ecc55421138e9fb6a15de5024d00fd
Reviewed-on: https://review.monogon.dev/c/monogon/+/3028
Reviewed-by: Serge Bazanski <serge@monogon.tech>
Vouch-Run-CI: Tim Windelschmidt <tim@monogon.tech>
Tested-by: Jenkins CI
diff --git a/metropolis/node/core/rpc/resolver/resolver.go b/metropolis/node/core/rpc/resolver/resolver.go
index 4e79bae..88d95d7 100644
--- a/metropolis/node/core/rpc/resolver/resolver.go
+++ b/metropolis/node/core/rpc/resolver/resolver.go
@@ -106,7 +106,7 @@
return r
}
-// ResolverOptions are passed to a Resolver being created.
+// ResolverOption are passed to a Resolver being created.
type ResolverOption func(r *Resolver)
// WithLogger configures a given function as the logger of the resolver. The
diff --git a/metropolis/node/core/rpc/trace.go b/metropolis/node/core/rpc/trace.go
index 934bcc9..0d43806 100644
--- a/metropolis/node/core/rpc/trace.go
+++ b/metropolis/node/core/rpc/trace.go
@@ -16,7 +16,7 @@
// Span implements a compatible subset of
// go.opentelemetry.io/otel/trace.Span.
-// It is used in place of trace.Span until opentelemetry support
+// Span is used in place of trace.Span until opentelemetry support
// is fully implemented and thus the library is pulled in. Once
// that happens, all relevant methods will be replace with an
// embedding of the trace.Span interface.