Skip to content

Commit 342e1d4

Browse files
authored
Polish document content in README.md (#542)
* Fix wrong spelling in README.md Fix wrong spelling in README.md * Polish document content
1 parent 24d4bc0 commit 342e1d4

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,16 +52,16 @@ for definition of maturity levels).
5252
Components marked `Stable` provide the following guarantees:
5353

5454
- Field types, numbers and names will not change.
55-
- Service names and service package names will not change.
55+
- Service names and `service` package names will not change.
5656
- Service method names will not change. [from 1.0.0]
5757
- Service method parameter names will not change. [from 1.0.0]
5858
- Service method parameter types and return types will not change. [from 1.0.0]
5959
- Service method kind (unary vs streaming) will not change.
60-
- Names of messages and enums will not change. [from 1.0.0]
61-
- Numbers assigned to enum choices will not change.
62-
- Names of enum choices will not change. [from 1.0.0]
63-
- The location of messages and enums, i.e. whether they are declared at the top lexical
64-
scope or nested inside another message will not change. [from 1.0.0]
60+
- Names of `message`s and `enum`s will not change. [from 1.0.0]
61+
- Numbers assigned to `enum` choices will not change.
62+
- Names of `enum` choices will not change. [from 1.0.0]
63+
- The location of `message`s and `enum`s, i.e. whether they are declared at the top lexical
64+
scope or nested inside another `message` will not change. [from 1.0.0]
6565
- Package names and directory structure will not change. [from 1.0.0]
6666
- `optional` and `repeated` declarators of existing fields will not change. [from 1.0.0]
6767
- No existing symbol will be deleted. [from 1.0.0]
@@ -71,12 +71,12 @@ with version number 1.0.0.
7171

7272
The following additive changes are allowed:
7373

74-
- Adding new fields to existing messages.
75-
- Adding new messages or enums.
76-
- Adding new choices to existing enums.
77-
- Adding new choices to existing oneof fields.
78-
- Adding new services.
79-
- Adding new methods to existing services.
74+
- Adding new fields to existing `message`s.
75+
- Adding new `message`s or `enum`s.
76+
- Adding new choices to existing `enum`s.
77+
- Adding new choices to existing `oneof` fields.
78+
- Adding new `service`s.
79+
- Adding new `method`s to existing `service`s.
8080

8181
All the additive changes above must be accompanied by an explanation about how
8282
new and old senders and receivers that implement the version of the protocol

0 commit comments

Comments
 (0)