diff options
author | Alexander Polcyn <apolcyn@google.com> | 2017-05-03 14:49:41 -0700 |
---|---|---|
committer | Alexander Polcyn <apolcyn@google.com> | 2017-05-05 11:02:07 -0700 |
commit | d809a15ec4913c7a8cd38d679a78b3edcb716b69 (patch) | |
tree | 32a3f1cfe4604c1c1003f25a6bbdfd95314e82aa /doc | |
parent | 3f716baa0a33529592c6cfeb64950fe463c4595f (diff) |
cpp doc nits
Diffstat (limited to 'doc')
-rw-r--r-- | doc/PROTOCOL-WEB.md | 2 | ||||
-rw-r--r-- | doc/compression.md | 4 | ||||
-rw-r--r-- | doc/cpp-style-guide.md | 3 | ||||
-rw-r--r-- | doc/fail_fast.md | 2 | ||||
-rw-r--r-- | doc/service_config.md | 4 | ||||
-rw-r--r-- | doc/stress_test_framework.md | 2 |
6 files changed, 8 insertions, 9 deletions
diff --git a/doc/PROTOCOL-WEB.md b/doc/PROTOCOL-WEB.md index 6bb280894a..5f37df9b0f 100644 --- a/doc/PROTOCOL-WEB.md +++ b/doc/PROTOCOL-WEB.md @@ -1,4 +1,4 @@ -# Overview +# gRPC Web gRPC-Web provides a JS client library that supports the same API as gRPC-Node to access a gRPC service. Due to browser limitation, diff --git a/doc/compression.md b/doc/compression.md index de245d90fe..ee22bc3f12 100644 --- a/doc/compression.md +++ b/doc/compression.md @@ -1,4 +1,4 @@ -## **gRPC Compression** +## gRPC Compression The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be @@ -112,7 +112,7 @@ unsupported condition as well as the supported ones. The returned 1. An ill-constructed message with its [Compressed-Flag bit](PROTOCOL-HTTP2.md#compressed-flag) set but lacking a -"[grpc-encoding](PROTOCOL-HTTP2.md#message-encoding)" +[grpc-encoding](PROTOCOL-HTTP2.md#message-encoding) entry different from _identity_ in its metadata MUST fail with `INTERNAL` status, its associated description indicating the invalid Compressed-Flag condition. diff --git a/doc/cpp-style-guide.md b/doc/cpp-style-guide.md index a1f91353fe..8211703d02 100644 --- a/doc/cpp-style-guide.md +++ b/doc/cpp-style-guide.md @@ -5,5 +5,4 @@ The majority of gRPC's C++ requirements are drawn from the [Google C++ style guide] (https://google.github.io/styleguide/cppguide.html). Additionally, as in C, layout rules are defined by clang-format, and all code should be passed through clang-format. A (docker-based) script to do -so is included in [tools/distrib/clang\_format\_code.sh] -(../tools/distrib/clang_format_code.sh). +so is included in [tools/distrib/clang_format_code.sh](../tools/distrib/clang_format_code.sh). diff --git a/doc/fail_fast.md b/doc/fail_fast.md index 2dd5561fc6..ff3d235397 100644 --- a/doc/fail_fast.md +++ b/doc/fail_fast.md @@ -1 +1 @@ -Moved to wait-for-ready.md +Moved to [wait-for-ready.md](wait-for-ready.md) diff --git a/doc/service_config.md b/doc/service_config.md index 8039fcad09..e790180f35 100644 --- a/doc/service_config.md +++ b/doc/service_config.md @@ -131,8 +131,8 @@ functionality is introduced. # Architecture -A service config is associated with a server name. The [name -resolver](naming.md) plugin, when asked to resolve a particular server +A service config is associated with a server name. The [nameresolver](naming.md) +plugin, when asked to resolve a particular server name, will return both the resolved addresses and the service config. TODO(roth): Design how the service config will be encoded in DNS. diff --git a/doc/stress_test_framework.md b/doc/stress_test_framework.md index 18f545e090..2212d9842c 100644 --- a/doc/stress_test_framework.md +++ b/doc/stress_test_framework.md @@ -2,7 +2,7 @@ (Sree Kuchibhotla - sreek@) -> Status: This is implemented. More details at [README.md](https://github.com/grpc/grpc/blob/master/tools/run_tests/stress_test/README.md) +Status: This is implemented. More details at [README.md](https://github.com/grpc/grpc/blob/master/tools/run_tests/stress_test/README.md) **I. GOALS** |