protoc-gen-go-grpc: add period to end of generated comment (#7392)

This commit is contained in:
infovivek2020 2024-07-12 21:29:09 +05:30 committed by GitHub
parent ee62e56b2e
commit e7d88223a7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
18 changed files with 24 additions and 24 deletions

View File

@ -72,7 +72,7 @@ type LoadBalancer_BalanceLoadClient = grpc.BidiStreamingClient[LoadBalanceReques
// LoadBalancerServer is the server API for LoadBalancer service.
// All implementations should embed UnimplementedLoadBalancerServer
// for forward compatibility
// for forward compatibility.
type LoadBalancerServer interface {
// Bidirectional rpc to get a list of servers.
BalanceLoad(grpc.BidiStreamingServer[LoadBalanceRequest, LoadBalanceResponse]) error

View File

@ -153,7 +153,7 @@ func (c *channelzClient) GetSocket(ctx context.Context, in *GetSocketRequest, op
// ChannelzServer is the server API for Channelz service.
// All implementations should embed UnimplementedChannelzServer
// for forward compatibility
// for forward compatibility.
//
// Channelz is a service exposed by gRPC servers that provides detailed debug
// information.

View File

@ -264,7 +264,7 @@ func genService(gen *protogen.Plugin, file *protogen.File, g *protogen.Generated
serverType := service.GoName + "Server"
g.P("// ", serverType, " is the server API for ", service.GoName, " service.")
g.P("// All implementations ", mustOrShould, " embed Unimplemented", serverType)
g.P("// for forward compatibility")
g.P("// for forward compatibility.")
// Copy comments from proto file.
genServiceComments(g, service)

View File

@ -75,7 +75,7 @@ type HandshakerService_DoHandshakeClient = grpc.BidiStreamingClient[HandshakerRe
// HandshakerServiceServer is the server API for HandshakerService service.
// All implementations must embed UnimplementedHandshakerServiceServer
// for forward compatibility
// for forward compatibility.
type HandshakerServiceServer interface {
// Handshaker service accepts a stream of handshaker request, returning a
// stream of handshaker response. Client is expected to send exactly one

View File

@ -123,7 +123,7 @@ type Echo_BidirectionalStreamingEchoClient = grpc.BidiStreamingClient[EchoReques
// EchoServer is the server API for Echo service.
// All implementations must embed UnimplementedEchoServer
// for forward compatibility
// for forward compatibility.
//
// Echo is the echo service.
type EchoServer interface {

View File

@ -66,7 +66,7 @@ func (c *greeterClient) SayHello(ctx context.Context, in *HelloRequest, opts ...
// GreeterServer is the server API for Greeter service.
// All implementations must embed UnimplementedGreeterServer
// for forward compatibility
// for forward compatibility.
//
// The greeting service definition.
type GreeterServer interface {

View File

@ -136,7 +136,7 @@ type RouteGuide_RouteChatClient = grpc.BidiStreamingClient[RouteNote, RouteNote]
// RouteGuideServer is the server API for RouteGuide service.
// All implementations must embed UnimplementedRouteGuideServer
// for forward compatibility
// for forward compatibility.
//
// Interface exported by the server.
type RouteGuideServer interface {

View File

@ -115,7 +115,7 @@ type Health_WatchClient = grpc.ServerStreamingClient[HealthCheckResponse]
// HealthServer is the server API for Health service.
// All implementations should embed UnimplementedHealthServer
// for forward compatibility
// for forward compatibility.
//
// Health is gRPC's mechanism for checking whether a server is able to handle
// RPCs. Its semantics are documented in

View File

@ -64,7 +64,7 @@ func (c *routeLookupServiceClient) RouteLookup(ctx context.Context, in *RouteLoo
// RouteLookupServiceServer is the server API for RouteLookupService service.
// All implementations must embed UnimplementedRouteLookupServiceServer
// for forward compatibility
// for forward compatibility.
type RouteLookupServiceServer interface {
// Lookup returns a target for a single key.
RouteLookup(context.Context, *RouteLookupRequest) (*RouteLookupResponse, error)

View File

@ -143,7 +143,7 @@ type BenchmarkService_StreamingBothWaysClient = grpc.BidiStreamingClient[SimpleR
// BenchmarkServiceServer is the server API for BenchmarkService service.
// All implementations must embed UnimplementedBenchmarkServiceServer
// for forward compatibility
// for forward compatibility.
type BenchmarkServiceServer interface {
// One request followed by one response.
// The server returns the client payload as-is.

View File

@ -67,7 +67,7 @@ func (c *reportQpsScenarioServiceClient) ReportScenario(ctx context.Context, in
// ReportQpsScenarioServiceServer is the server API for ReportQpsScenarioService service.
// All implementations must embed UnimplementedReportQpsScenarioServiceServer
// for forward compatibility
// for forward compatibility.
type ReportQpsScenarioServiceServer interface {
// Report results of a QPS test benchmark scenario.
ReportScenario(context.Context, *ScenarioResult) (*Void, error)

View File

@ -189,7 +189,7 @@ func (c *testServiceClient) UnimplementedCall(ctx context.Context, in *Empty, op
// TestServiceServer is the server API for TestService service.
// All implementations must embed UnimplementedTestServiceServer
// for forward compatibility
// for forward compatibility.
//
// A simple service to test the various types of RPCs and experiment with
// performance with various types of payload.
@ -454,7 +454,7 @@ func (c *unimplementedServiceClient) UnimplementedCall(ctx context.Context, in *
// UnimplementedServiceServer is the server API for UnimplementedService service.
// All implementations must embed UnimplementedUnimplementedServiceServer
// for forward compatibility
// for forward compatibility.
//
// A simple service NOT implemented at servers so clients can test for
// that case.
@ -563,7 +563,7 @@ func (c *reconnectServiceClient) Stop(ctx context.Context, in *Empty, opts ...gr
// ReconnectServiceServer is the server API for ReconnectService service.
// All implementations must embed UnimplementedReconnectServiceServer
// for forward compatibility
// for forward compatibility.
//
// A service used to control reconnect server.
type ReconnectServiceServer interface {
@ -698,7 +698,7 @@ func (c *loadBalancerStatsServiceClient) GetClientAccumulatedStats(ctx context.C
// LoadBalancerStatsServiceServer is the server API for LoadBalancerStatsService service.
// All implementations must embed UnimplementedLoadBalancerStatsServiceServer
// for forward compatibility
// for forward compatibility.
//
// A service used to obtain stats for verifying LB behavior.
type LoadBalancerStatsServiceServer interface {
@ -850,7 +850,7 @@ func (c *hookServiceClient) ClearReturnStatus(ctx context.Context, in *Empty, op
// HookServiceServer is the server API for HookService service.
// All implementations must embed UnimplementedHookServiceServer
// for forward compatibility
// for forward compatibility.
//
// Hook service. Used to keep Kubernetes from shutting the pod down.
type HookServiceServer interface {
@ -1025,7 +1025,7 @@ func (c *xdsUpdateHealthServiceClient) SendHookRequest(ctx context.Context, in *
// XdsUpdateHealthServiceServer is the server API for XdsUpdateHealthService service.
// All implementations must embed UnimplementedXdsUpdateHealthServiceServer
// for forward compatibility
// for forward compatibility.
//
// A service to remotely control health status of an xDS test server.
type XdsUpdateHealthServiceServer interface {
@ -1174,7 +1174,7 @@ func (c *xdsUpdateClientConfigureServiceClient) Configure(ctx context.Context, i
// XdsUpdateClientConfigureServiceServer is the server API for XdsUpdateClientConfigureService service.
// All implementations must embed UnimplementedXdsUpdateClientConfigureServiceServer
// for forward compatibility
// for forward compatibility.
//
// A service to dynamically update the configuration of an xDS test client.
type XdsUpdateClientConfigureServiceServer interface {

View File

@ -122,7 +122,7 @@ func (c *workerServiceClient) QuitWorker(ctx context.Context, in *Void, opts ...
// WorkerServiceServer is the server API for WorkerService service.
// All implementations must embed UnimplementedWorkerServiceServer
// for forward compatibility
// for forward compatibility.
type WorkerServiceServer interface {
// Start server with specified workload.
// First request sent specifies the ServerConfig followed by ServerStatus

View File

@ -94,7 +94,7 @@ func (c *metricsServiceClient) GetGauge(ctx context.Context, in *GaugeRequest, o
// MetricsServiceServer is the server API for MetricsService service.
// All implementations must embed UnimplementedMetricsServiceServer
// for forward compatibility
// for forward compatibility.
type MetricsServiceServer interface {
// Returns the values of all the gauges that are currently being maintained by
// the service

View File

@ -81,7 +81,7 @@ func (c *profilingClient) GetStreamStats(ctx context.Context, in *GetStreamStats
// ProfilingServer is the server API for Profiling service.
// All implementations should embed UnimplementedProfilingServer
// for forward compatibility
// for forward compatibility.
//
// The Profiling service exposes functions to remotely manage the gRPC
// profiling behaviour in a program.

View File

@ -75,7 +75,7 @@ type ServerReflection_ServerReflectionInfoClient = grpc.BidiStreamingClient[Serv
// ServerReflectionServer is the server API for ServerReflection service.
// All implementations should embed UnimplementedServerReflectionServer
// for forward compatibility
// for forward compatibility.
type ServerReflectionServer interface {
// The reflection service is structured as a bidirectional stream, ensuring
// all related requests go to a single server.

View File

@ -72,7 +72,7 @@ type ServerReflection_ServerReflectionInfoClient = grpc.BidiStreamingClient[Serv
// ServerReflectionServer is the server API for ServerReflection service.
// All implementations should embed UnimplementedServerReflectionServer
// for forward compatibility
// for forward compatibility.
type ServerReflectionServer interface {
// The reflection service is structured as a bidirectional stream, ensuring
// all related requests go to a single server.

View File

@ -78,7 +78,7 @@ type SearchService_StreamingSearchClient = grpc.BidiStreamingClient[SearchReques
// SearchServiceServer is the server API for SearchService service.
// All implementations must embed UnimplementedSearchServiceServer
// for forward compatibility
// for forward compatibility.
type SearchServiceServer interface {
Search(context.Context, *SearchRequest) (*SearchResponse, error)
StreamingSearch(grpc.BidiStreamingServer[SearchRequest, SearchResponse]) error