Merge pull request grpc-ecosystem#99 from thurt/patch-1

Spelling/grammar corrections for validator docs

Author: domgreen

validator/DOC.md

@@ -6,16 +6,16 @@
 * [Index](#pkg-index)
 
 ## <a name="pkg-overview">Overview</a>
-`grpc_validator` a generic request contents validator server-side middleware for gRPC.
+`grpc_validator` is a generic request contents validator server-side middleware for gRPC.
 
 ### Request Validator Middleware
-Validating input is important, and hard. It also causes a lot of boiler plate. This middleware
-checks for the existance of a `Validate` method on each of the messages of a gRPC request. This
+Validating input is important, and hard. It also causes a lot of boilerplate code. This middleware
+checks for the existence of a `Validate` method on each of the messages of a gRPC request. This
 includes the single request of the `Unary` calls, as well as each message of the inbound Stream calls.
-In case of a validation failure, a `InvalidArgument` gRPC status is returned, alongside with a
+In case of a validation failure, an `InvalidArgument` gRPC status is returned, along with a
 description of the validation failure.
 
-While it is generic, it was indented to be used with <a href="https://github.com/mwitkow/go-proto-validators">https://github.com/mwitkow/go-proto-validators</a>,
+While it is generic, it was intended to be used with <a href="https://github.com/mwitkow/go-proto-validators">https://github.com/mwitkow/go-proto-validators</a>,
 a Go protocol buffers codegen plugin that creates the `Validate` methods (including nested messages)
 based on declarative options in the `.proto` files themselves. For example:
 
@@ -37,11 +37,11 @@ based on declarative options in the `.proto` files themselves. For example:
 	  InnerMessage inner = 2 [(validator.field) = {msg_exists : true}];
 	}
 
-The `OuterMessage.Validate` would include validation of regexes, existance of the InnerMessage and
+The `OuterMessage.Validate` would include validation of regexes, existence of the InnerMessage and
 the range values within it. The `grpc_validator` middleware would then automatically use that to
 check all messages processed by the server.
 
-Please consult <a href="https://github.com/mwitkow/go-proto-validators">https://github.com/mwitkow/go-proto-validators</a> for details of `protoc` invoation and
+Please consult <a href="https://github.com/mwitkow/go-proto-validators">https://github.com/mwitkow/go-proto-validators</a> for details on `protoc` invocation and
 other parameters of customization.
 
 ## <a name="pkg-imports">Imported Packages</a>
@@ -61,7 +61,7 @@ other parameters of customization.
 ``` go
 func StreamServerInterceptor() grpc.StreamServerInterceptor
 ```
-StreamServerInterceptor returns a new streaming server interceptors that validates incoming messages.
+StreamServerInterceptor returns a new streaming server interceptor that validates incoming messages.
 
 The stage at which invalid messages will be rejected with `InvalidArgument` varies based on the
 type of the RPC. For `ServerStream` (1:m) requests, it will happen before reaching any userspace
@@ -72,7 +72,7 @@ calls to `stream.Recv()`.
 ``` go
 func UnaryServerInterceptor() grpc.UnaryServerInterceptor
 ```
-UnaryServerInterceptor returns a new unary server interceptors that validates incoming messages.
+UnaryServerInterceptor returns a new unary server interceptor that validates incoming messages.
 
 Invalid messages will be rejected with `InvalidArgument` before reaching any userspace handlers.
 

validator/README.md

@@ -1,21 +1,21 @@
 # grpc_validator
---
+
     import "github.com/grpc-ecosystem/go-grpc-middleware/validator"
 
-`grpc_validator` a generic request contents validator server-side middleware for
+`grpc_validator` is a generic request contents validator server-side middleware for
 gRPC.
 
 
 ### Request Validator Middleware
 
-Validating input is important, and hard. It also causes a lot of boiler plate.
-This middleware checks for the existance of a `Validate` method on each of the
+Validating input is important, and hard. It also causes a lot of boilerplate code.
+This middleware checks for the existence of a `Validate` method on each of the
 messages of a gRPC request. This includes the single request of the `Unary`
 calls, as well as each message of the inbound Stream calls. In case of a
-validation failure, a `InvalidArgument` gRPC status is returned, alongside with
+validation failure, an `InvalidArgument` gRPC status is returned, along with
 a description of the validation failure.
 
-While it is generic, it was indented to be used with
+While it is generic, it was intended to be used with
 https://github.com/mwitkow/go-proto-validators, a Go protocol buffers codegen
 plugin that creates the `Validate` methods (including nested messages) based on
 declarative options in the `.proto` files themselves. For example:
@@ -38,12 +38,12 @@ declarative options in the `.proto` files themselves. For example:
       InnerMessage inner = 2 [(validator.field) = {msg_exists : true}];
     }
 
-The `OuterMessage.Validate` would include validation of regexes, existance of
+The `OuterMessage.Validate` would include validation of regexes, existence of
 the InnerMessage and the range values within it. The `grpc_validator` middleware
 would then automatically use that to check all messages processed by the server.
 
-Please consult https://github.com/mwitkow/go-proto-validators for details of
-`protoc` invoation and other parameters of customization.
+Please consult https://github.com/mwitkow/go-proto-validators for details on
+`protoc` invocation and other parameters of customization.
 
 ## Usage
 
@@ -52,7 +52,7 @@ Please consult https://github.com/mwitkow/go-proto-validators for details of
 ```go
 func StreamServerInterceptor() grpc.StreamServerInterceptor
 ```
-StreamServerInterceptor returns a new streaming server interceptors that
+StreamServerInterceptor returns a new streaming server interceptor that
 validates incoming messages.
 
 The stage at which invalid messages will be rejected with `InvalidArgument`
@@ -66,7 +66,7 @@ happen before reaching any userspace handlers. For `ClientStream` (n:1) or
 ```go
 func UnaryServerInterceptor() grpc.UnaryServerInterceptor
 ```
-UnaryServerInterceptor returns a new unary server interceptors that validates
+UnaryServerInterceptor returns a new unary server interceptor that validates
 incoming messages.
 
 Invalid messages will be rejected with `InvalidArgument` before reaching any

validator/doc.go

@@ -2,17 +2,17 @@
 // See LICENSE for licensing terms.
 
 /*
-`grpc_validator` a generic request contents validator server-side middleware for gRPC.
+`grpc_validator` is a generic request contents validator server-side middleware for gRPC.
 
 Request Validator Middleware
 
-Validating input is important, and hard. It also causes a lot of boiler plate. This middleware
-checks for the existance of a `Validate` method on each of the messages of a gRPC request. This
+Validating input is important, and hard. It also causes a lot of boilerplate code. This middleware
+checks for the existence of a `Validate` method on each of the messages of a gRPC request. This
 includes the single request of the `Unary` calls, as well as each message of the inbound Stream calls.
-In case of a validation failure, a `InvalidArgument` gRPC status is returned, alongside with a
+In case of a validation failure, an `InvalidArgument` gRPC status is returned, along with a
 description of the validation failure.
 
-While it is generic, it was indented to be used with https://github.com/mwitkow/go-proto-validators,
+While it is generic, it was intended to be used with https://github.com/mwitkow/go-proto-validators,
 a Go protocol buffers codegen plugin that creates the `Validate` methods (including nested messages)
 based on declarative options in the `.proto` files themselves. For example:
 
@@ -35,11 +35,11 @@ based on declarative options in the `.proto` files themselves. For example:
 	  InnerMessage inner = 2 [(validator.field) = {msg_exists : true}];
 	}
 
-The `OuterMessage.Validate` would include validation of regexes, existance of the InnerMessage and
+The `OuterMessage.Validate` would include validation of regexes, existence of the InnerMessage and
 the range values within it. The `grpc_validator` middleware would then automatically use that to
 check all messages processed by the server.
 
-Please consult https://github.com/mwitkow/go-proto-validators for details of `protoc` invoation and
+Please consult https://github.com/mwitkow/go-proto-validators for details on `protoc` invocation and
 other parameters of customization.
 */
 package grpc_validator

validator/validator.go

@@ -13,7 +13,7 @@ type validator interface {
 	Validate() error
 }
 
-// UnaryServerInterceptor returns a new unary server interceptors that validates incoming messages.
+// UnaryServerInterceptor returns a new unary server interceptor that validates incoming messages.
 //
 // Invalid messages will be rejected with `InvalidArgument` before reaching any userspace handlers.
 func UnaryServerInterceptor() grpc.UnaryServerInterceptor {
@@ -27,7 +27,7 @@ func UnaryServerInterceptor() grpc.UnaryServerInterceptor {
 	}
 }
 
-// StreamServerInterceptor returns a new streaming server interceptors that validates incoming messages.
+// StreamServerInterceptor returns a new streaming server interceptor that validates incoming messages.
 //
 // The stage at which invalid messages will be rejected with `InvalidArgument` varies based on the
 // type of the RPC. For `ServerStream` (1:m) requests, it will happen before reaching any userspace