From 8798f2997b76024e900f6d846a2893f62f6cd7fe Mon Sep 17 00:00:00 2001 From: cuishuang Date: Tue, 1 Mar 2022 20:55:42 +0800 Subject: [PATCH] chore: fix typos --- docs/README.md | 2 +- docs/breaking.md | 4 ++-- docs/protoc.md | 2 +- style/README.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index c48b4456f..e74f15bcb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -273,7 +273,7 @@ if there are any source or wire incompatible changes. Some notes on this command Produce a serialized `FileDescriptorSet` for all Protobuf definitions. By default, the serialized `FileDescriptorSet` is printed to stdout. There are a few options: -- `--include-imports, --include-source-info` are analagous to `protoc`'s `--include_imports, +- `--include-imports, --include-source-info` are analogous to `protoc`'s `--include_imports, --include_source_info` flags. - `--json` outputs the FileDescriptorSet as JSON instead of binary. - `-o` writes the `FileDescriptorSet` to the given output file path. diff --git a/docs/breaking.md b/docs/breaking.md index dabfe837e..4400fbe36 100644 --- a/docs/breaking.md +++ b/docs/breaking.md @@ -89,7 +89,7 @@ definitions. ### Saved State If not using git, or you would prefer not to rely on git state to compare your Protobuf definitions -for breaking changes, you can instead save state to a file and use that for comparsion. +for breaking changes, you can instead save state to a file and use that for comparison. To save your current state: @@ -120,7 +120,7 @@ understands the concept of beta vs. stable packages. If a package's last component is `vMAJORbetaBETA`, where `MAJOR` and `BETA` are both greater than 0, `prototool break check` will understand that this package is a -beta package, otherwise the package is understood as a stable pacakge. +beta package, otherwise the package is understood as a stable package. The following are examples of beta packages. diff --git a/docs/protoc.md b/docs/protoc.md index 4ae5aec57..c15441cdc 100644 --- a/docs/protoc.md +++ b/docs/protoc.md @@ -43,7 +43,7 @@ this can be done in one of three ways. commands. The Well-Known Type path should be the directory that includes the `google/protobuf` directory containing the Well-Known Types. - By setting the `PROTOTOOL_PROTOC_BIN_PATH` and `PROTOTOOL_PROTOC_WKT_PATH` environment variables, - as we do in the [provided Docker image](docker.md). These variables are analagous to the + as we do in the [provided Docker image](docker.md). These variables are analogous to the `--protoc-bin-path` and `--protoc-wkt-path` flags, however the flags take precedence. If any of these options are set, the `protoc.version` option in the `prototool.yaml` file is diff --git a/style/README.md b/style/README.md index 73d544211..12b23506c 100644 --- a/style/README.md +++ b/style/README.md @@ -1153,7 +1153,7 @@ capitalization. - `common` - Common has no semantic meaning. See the above discussions on not having common messages. Use a name that reflects the actual meaning of what you are representing instead. - `data` - The name "data" is a superfluous decorator. All Protobuf types are data. Use of - "data" also causes singular vs plural issues during iteration, as the singluar of "data" is + "data" also causes singular vs plural issues during iteration, as the singular of "data" is "datum". If you must have a type that needs such a decorator, use "info" instead. - `uuid` - We use "id" instead of "uuid" for purposes of consistency. An ID is meant to be a UUID unless otherwise specified.