Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spelling #2547

Merged
merged 25 commits into from
Feb 13, 2025
Merged

Spelling #2547

merged 25 commits into from
Feb 13, 2025

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Feb 12, 2025

This PR corrects misspellings identified by the check-spelling action

The misspellings have been reported at https://github.com/jsoref/caliban/actions/runs/13278582458#summary-37072536513

The action reports that the changes in this PR would make it happy: https://github.com/jsoref/caliban/actions/runs/13278582569#summary-37072536820

Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
@@ -14,5 +14,5 @@ npx @apollo/federation-subgraph-compatibility docker --compose apollo-compatibil
### Printing the GraphQL Schema (SDL)

```
sbt "apollo-compability/run printSchema"
sbt "apollo-compatibility/run printSchema"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

notable?

Comment on lines -27 to -28
mapbeAllIDs: [ID!] @newtype(name: "MaybeInnerId")
mapbeAllIDsOpt: [ID] @newtype(name: "MaybeInnerIdOpt")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kinda odd...

@@ -21,7 +21,7 @@
</a></div><div class="nav-item"><a href="/caliban/about/" aria-current="page" class="nav-link router-link-exact-active router-link-active">
About
</a></div><div class="nav-item"><a href="https://github.com/ghostdogpr/caliban" target="_blank" rel="noopener noreferrer" class="nav-link external">
Github
GitHub
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy to drop any particular change.

Afaict, this is all just the literal GitHub as opposed to a class or anything exciting (unlike GitLab where Gitlab appeared once in a class-ish thing...)

@@ -232,7 +232,7 @@ object TapirAdapterSpec {
test("Returns 400 status code on validation errors") {
def test_(method: String) =
for {
resp <- runHttpRequest(method, acceptHeader, query = "{characterss { name }}")
resp <- runHttpRequest(method, acceptHeader, query = "{characters_ { name }}")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming this is just trying to validate for something other than characters and I find using a _ is sufficient proof of that, while allowing a spell checker to identify other real typos...

@@ -298,24 +298,24 @@ object SchemaWriter {
|}""".stripMargin
}

def replaceNameOfInnertype(name: String, ftype: Type): Type =
def replaceNameOfInnerType(name: String, ftype: Type): Type =
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's possible Innertype is a reserved concept, but I'm hoping it's just Inner+Type

@@ -120,7 +120,7 @@ object RemoteQuerySpec extends ZIOSpecDefault {
actual == """query{union(value:"{\"foo\": \"\\n\"}"){...on Interface{id}}}"""
)
},
test("correctly renders a query for a field of json escaped escaped quote") {
test("correctly renders a query for a field of json double escaped quote") {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's really hard to tell if this is intentionally doubled or accidentally, using the word double instead makes it clear...

@@ -29,7 +29,7 @@ These interpreters expose 2 powerful methods:
- `configure` takes a `Configurator[R]` which is an alias for `URIO[R & Scope, Unit]`.
It allows configuring the interpreter by running an effect that will run for each request and that can modify the configuration of the running fiber. Built-in configurators such as `Configurator.setSkipValidation`, `Configurator.setEnableIntrospection` and `Configurator.setQueryExecution` let you dynamically change the configuration of the interpreter.
- `intercept` takes an `Interceptor[-R1, +R]` which is an alias for `ZLayer[R1 & ServerRequest, TapirResponse, R]`.
It is basically a more powerful version of `configure` that gives you access to the incoming request (`ServerRequest`) and lets you modify the environment of the interpreter (from `R` to `R1`). A typical use case would be to extract an authentication token from the request and eliminate the authentication requirement from the environment if the token is valid. See an example [here](https://github.com/ghostdogpr/caliban/blob/series/2.x/examples/src/main/scala/example/akkahttp/AuthExampleApp.scala#L51).
It is basically a more powerful version of `configure` that gives you access to the incoming request (`ServerRequest`) and lets you modify the environment of the interpreter (from `R` to `R1`). A typical use case would be to extract an authentication token from the request and eliminate the authentication requirement from the environment if the token is valid. See an example route [`HttpInterpreter(...)...intercept(...)`](https://github.com/ghostdogpr/caliban/blame/58b459bd7fb2ca0b20fc62226aa1afc4edefa26d/examples/src/main/scala/example/akkahttp/AuthExampleApp.scala#L51).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not use (click) here links

For more information, see:

(?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\()

@@ -119,7 +119,7 @@ by using `caliban.federation.v2_x` where `x` is the minor version of the specifi
| Directive | Caliban Type | Version | Caliban package
--------------| --------------|---------| ---------------
| `@shareable` | `@GQLShareable` | v2.0 | `caliban.federation.v2_0`
| `@inaccessable` | `@GQLInaccessible` | v2.0 | `caliban.federation.v2_0`
| `@inaccessible` | `@GQLInaccessible` | v2.0 | `caliban.federation.v2_0`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

notable. I hope this is correct, it's pretty odd to have this spelling...

Copy link
Owner

@ghostdogpr ghostdogpr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quite a lot of typos, thanks! 😊

Signed-off-by: Josh Soref <[email protected]>
@@ -36,7 +36,7 @@ module.exports = {
link: '/about/'
},
{
text: 'Github',
text: 'GitHub',
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line was the thing that was updating the other .html files, but I've dropped the changes to the html files...

Copy link
Owner

@ghostdogpr ghostdogpr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ghostdogpr ghostdogpr merged commit 59a511f into ghostdogpr:series/2.x Feb 13, 2025
11 checks passed
@jsoref jsoref deleted the spelling branch February 13, 2025 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants