Skip to content

Commit da1adca

Browse files
authored
Fix typos in README.md (#423)
1 parent ee84fd2 commit da1adca

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ can import packages from `gnostic-models` instead of `gnostic`.
3737

3838
[google/gnostic-grpc](https://github.com/google/gnostic-grpc) contains a
3939
gnostic plugin that can generate an annotated Protocol Buffer description of an
40-
API that, when transcode, produces an API that conforms to a specified OpenAPI
40+
API that, when transcoded, produces an API that conforms to a specified OpenAPI
4141
document. To go from protobuf to OpenAPI, see the
4242
[protoc-gen-openapi](cmd/protoc-gen-openapi) tool in this project.
4343

@@ -69,12 +69,12 @@ and later.
6969
git clone https://github.com/google/gnostic
7070
cd gnostic
7171

72-
2. Verify that you have a local installation of `protoc`. You can get protoc
72+
2. Verify that you have a local installation of `protoc`. You can get `protoc`
7373
[here](https://github.com/protocolbuffers/protobuf).
7474

7575
3. Build **gnostic** with `make`. This uses
7676
[go generate](https://blog.golang.org/generate) to build support code
77-
including code generated by `protoc` and the Go protoc plugin, which is
77+
including code generated by `protoc` and the Go `protoc` plugin, which is
7878
automatically downloaded from
7979
[github.com/golang/protobuf](https://github.com/golang/protobuf) by the
8080
[COMPILE-PROTOS.sh](COMPILE-PROTOS.sh) script. This also builds all plugins

openapiv3/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ Gnostic applications and plugins can use OpenAPIv3.proto to generate Protocol
77
Buffer support code for their preferred languages.
88

99
OpenAPIv3.go is used by Gnostic to read JSON and YAML OpenAPI descriptions into
10-
the Protocol Buffer-based datastructures generated from OpenAPIv3.proto.
10+
the Protocol Buffer-based data structures generated from OpenAPIv3.proto.
1111

1212
OpenAPIv3.proto and OpenAPIv3.go are generated by the Gnostic compiler
13-
generator, and OpenAPIv3.pb.go is generated by protoc, the Protocol Buffer
14-
compiler, and protoc-gen-go, the Protocol Buffer Go code generation plugin.
13+
generator, and OpenAPIv3.pb.go is generated by `protoc`, the Protocol Buffer
14+
compiler, and `protoc-gen-go`, the Protocol Buffer Go code generation plugin.
1515

16-
openapi-3.1.json is a JSON schema for OpenAPI 3.1 that is automatically
16+
`openapi-3.1.json` is a JSON schema for OpenAPI 3.1 that is automatically
1717
generated from the OpenAPI 3.1 specification. It is not an official JSON Schema
1818
for OpenAPI.
1919

0 commit comments

Comments
 (0)