some small fixes (documentation/code) #2205
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmartisk
reviewed
Oct 4, 2024
docs/namespaces-on-server-side.md
Outdated
| @@ -63,7 +63,7 @@ type User { | |||
| } | |||
| ``` | |||
|
|
|||
| And you will can send such request | |||
| And you can send such a GraphQL request | |||
There was a problem hiding this comment.
Suggested change
| And you can send such a GraphQL request | |
| And you can send GraphQL request like |
jmartisk
reviewed
Oct 4, 2024
docs/namespaces-on-server-side.md
Outdated
| @@ -79,7 +79,7 @@ query { | |||
| ## Using @Name annotation (deprecated) | |||
| > [NOTE] This feature may be removed in the future. | |||
|
|
|||
| Does the same thing as @Namespace, the only difference is that there can only be one nesting level. | |||
| It does the same thing as `@Namespace`; the only difference is that there can only be one nesting level. | |||
There was a problem hiding this comment.
Suggested change
| It does the same thing as `@Namespace`; the only difference is that there can only be one nesting level. | |
| It does the same thing as `@Namespace`, the only difference is that there can only be one nesting level. |
jmartisk
reviewed
Oct 4, 2024
docs/namespaces-on-server-side.md
Outdated
| @@ -142,8 +141,8 @@ subscription { | |||
| ``` | |||
|
|
|||
| There is currently no way around this problem. | |||
| You must move subscriptions into a separate class that is not placed in a namespace. | |||
| You must move subscriptions into a separate class that is not placed within the namespace. | |||
There was a problem hiding this comment.
Suggested change
| You must move subscriptions into a separate class that is not placed within the namespace. | |
| You must move subscriptions into a separate `@GraphQLApi` class that does not declare any namespace. |
jmartisk
reviewed
Oct 4, 2024
docs/namespaces-on-server-side.md
Outdated
|
|
||
| > [NOTE] | ||
| > Be very careful when designing API with namespace. | ||
| > And take into account all the features of working with mutations and subscriptions. | ||
| > And consider all the features of working with mutations and subscriptions. |
There was a problem hiding this comment.
Suggested change
| > And consider all the features of working with mutations and subscriptions. | |
| > And be aware of all the potential consequences when working with mutations and subscriptions. |
jmartisk
reviewed
Oct 4, 2024
docs/typesafe-client-usage.md
Outdated
|
|
||
| > [NOTE] You can only use one of the annotations - @Name or @Namespace over the GraphQLApi classes. | ||
| > [NOTE] You can only use one of the annotations - `@Name` or `@Namespace` over the GraphQLApi classes. |
There was a problem hiding this comment.
Suggested change
| > [NOTE] You can only use one of the annotations - `@Name` or `@Namespace` over the GraphQLApi classes. | |
| > [NOTE] You can only use one of the annotations - `@Name` or `@Namespace` on a `GraphClientQLApi` interface. |
mskacelik
force-pushed
the
smaller-fixes
branch
from
740fc15 to
0bd1184
Compare
jmartisk
approved these changes
Oct 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
/cc @jmartisk