Skip to content

Commit 7c070dd

Browse files
authored
fix: typos and grammar isssues (#398)
This PR fixes minor typos and grammatical issues across the project. I have: - [x] Written a clear PR title and description (above) - [x] Signed the [Khan Academy CLA](https://www.khanacademy.org/r/cla) - [ ] Added tests covering my changes, if applicable - [ ] Included a link to the issue fixed, if applicable - [ ] Included documentation, for new features - [x] Added an entry to the changelog
1 parent 01cfbc3 commit 7c070dd

19 files changed

+32
-30
lines changed

docs/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ Note that genqlient now requires Go 1.23 or higher, and is tested through Go 1.2
3030

3131
### Bug fixes:
3232

33+
- fixed minor typos and grammatical issues across the project
34+
3335
## v0.8.1
3436

3537
This release fixes a bug introduced in v0.8.0 breaking path resolution on Windows, along with some other small features and bugs.

docs/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
106106
### 4. Permanent Ban
107107

108108
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
109+
standards, including sustained inappropriate behavior, harassment of an
110110
individual, or aggression toward or disparagement of classes of individuals.
111111

112112
**Consequence**: A permanent ban from any sort of public interaction within

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ See the [versioning strategy](versioning.md) for when to make a release. To make
5656
- Add a new section to the changelog for the release (see comments in the changelog for instructions), and add a brief summary of the release at the top.
5757
- Make a PR with the above. (Example: [#208](https://github.com/Khan/genqlient/pull/208).)
5858
- After it merges, tag it as the new release, e.g. `git checkout main && git pull && git tag v0.X.Y && git push origin v0.X.Y`.
59-
- Then, create a release in github, either [on the web](https://github.com/Khan/genqlient/releases/new) or with `export VERSION=v0.6.0; gh release create $VERSION --latest --verify-tag --generate-notes --title $VERSION`. (TODO(benkraft): Figure out how to pull in the changelog we've already written instead!)
59+
- Then, create a release in GitHub, either [on the web](https://github.com/Khan/genqlient/releases/new) or with `export VERSION=v0.6.0; gh release create $VERSION --latest --verify-tag --generate-notes --title $VERSION`. (TODO(benkraft): Figure out how to pull in the changelog we've already written instead!)

docs/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ type User2 struct {
8989
}
9090
```
9191

92-
Moreover, these types names should be as stable as possible: changing one part of a query (or another query) shouldn't change the type-names. And ideally, we might deduplicate: in a query like `{ self { id } myChildren { id } }` we'd be able to use a single type for both `self` and `myChildren`. Although maybe, if you want that, you have to use a fragment; it's clearly in conflict with having stable names. Or we can actually make this configurable!
92+
Moreover, these type names should be as stable as possible: changing one part of a query (or another query) shouldn't change the type-names. And ideally, we might deduplicate: in a query like `{ self { id } myChildren { id } }` we'd be able to use a single type for both `self` and `myChildren`. Although maybe, if you want that, you have to use a fragment; it's clearly in conflict with having stable names. Or we can actually make this configurable!
9393

9494
In other tools:
9595
- Apollo mostly uses named types (except alternatives of an interface/fragment are inline in TypeScript, but not in Flow), and in the above example names them, respectively, `MyQuery_user_User` and `MyQuery_user_User_children_User`, or maybe in some versions `MyQuery_user` and `MyQuery_user_children` in Flow/TypeScript. In Java and Scala in some cases they use nested types, e.g. `MyQuery.User.Children`.

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ If your tools are backed by [gopls](https://github.com/golang/tools/blob/master/
9797

9898
### genqlient fails after `go mod tidy`
9999

100-
If genqlient fails with an error `missing go.sum entry for module providing package`, this is typically because `go mod tidy` removed its dependencies because they weren't imported by your Go module. You can read more about this in golang/go#45552; see in particular [this comment](https://github.com/golang/go/issues/45552#issuecomment-819545037). In short, if you want to be able to `go run` on newer Go you'll need to have a (blank) import of genqlient's entrypoint in a special `tools.go` file somewhere in your module so `go mod tidy` doesn't prune it:
100+
If genqlient fails with an error `missing go.sum entry for module providing package`, this is typically because `go mod tidy` removed its dependencies because they weren't imported by your Go module. You can read more about this in golang/go#45552; see in particular [this comment](https://github.com/golang/go/issues/45552#issuecomment-819545037). In short, if you want to be able to `go run` on newer Go you'll need to have a (blank) import of genqlient's entrypoint in a special `tools.go` file somewhere in your module so `go mod tidy` doesn't prune it:
101101

102102
```go
103103
//go:build tools

docs/genqlient.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ bindings:
232232
# unmarshaler and marshaler are also valid here, see above for details.
233233

234234
# A list of packages for which genqlient should automatically generate
235-
# bindings. This is equivalent to adding a entry
235+
# bindings. This is equivalent to adding an entry
236236
# TypeName:
237237
# type: github.com/you/yourpkg/models.TypeName
238238
# to the bindings map, above, for each exported type in the package. Multiple

docs/genqlient_directive.graphql

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ directive genqlient(
222222
# name
223223
# }
224224
# }
225-
# will cause gnqlient to generate:
225+
# will cause genqlient to generate:
226226
# type Resp struct {
227227
# User User
228228
# }

docs/operations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ and genqlient will generate a Go field `MyGreatName string`. Note that the alia
355355

356356
### Type names
357357

358-
genqlient generates quite verbose type names in many cases. (In short, this is because the same `User` GraphQL type must map to different Go types depending which fields are requested; see the FAQ for [more](faq.md#why-does-genqlient-generate-such-complicated-type-names-).
358+
genqlient generates quite verbose type names in many cases. (In short, this is because the same `User` GraphQL type must map to different Go types depending on which fields are requested; see the FAQ for [more](faq.md#why-does-genqlient-generate-such-complicated-type-names-).
359359

360360
For example, in the following query there are two different user structs.
361361
```graphql
@@ -400,7 +400,7 @@ For any GraphQL types or fields with documentation in the GraphQL schema, genqli
400400
# This query gets the current user.
401401
#
402402
# If you also need to specify options on the query, you can put
403-
# the @genqlient directive after the docuentation, like this:
403+
# the @genqlient directive after the documentation, like this:
404404
#
405405
# @genqlient(omitempty: true)
406406
query GetUser { ... }

docs/schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ The GraphQL spec officially defines the `Int` type to be a [signed 32-bit intege
9696
- [Apollo Client](https://github.com/apollographql/apollo-client) doesn't check (but implicitly is limited to 53 bits by JavaScript)
9797
- [shurcooL/graphql](https://github.com/shurcooL/graphql) requires integers be passed as a `graphql.Int`, defined to be an `int32`
9898

99-
By default, genqlient maps GraphQL `Int`s to Go's `int`, meaning that on 64 bit systems there's no client-side restriction. This is convenient for most use cases, but means the client won't prevent you from passing a 64-bit integer to a server that will reject or truncate it.
99+
By default, genqlient maps GraphQL `Int`s to Go's `int`, meaning that on 64-bit systems there's no client-side restriction. This is convenient for most use cases, but means the client won't prevent you from passing a 64-bit integer to a server that will reject or truncate it.
100100

101101
If you prefer to limit integers to `int32`, you can set a binding in your `genqlient.yaml`:
102102

docs/subscriptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ To change the websocket protocol from its default value `graphql-transport-ws`,
129129

130130
## Authenticate subscriptions
131131

132-
Graphql allows to authenticate subscriptions using HTTP headers (inside the http upgrade request) or using connection parameters (first message inside the websocket connection).
132+
Graphql supports authenticated subscriptions using HTTP headers (inside the http upgrade request) or using connection parameters (first message inside the websocket connection).
133133
To authenticate using both methods, you need to add a `graphql.WebSocketOption` to the `graphql.NewClientUsingWebSocket` method.
134134

135135
### Example using HTTP headers

0 commit comments

Comments
 (0)