doc: fix mistakes in v2 tutorial #785
Open
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
antoineco
commented
Apr 26, 2024
| @@ -101,7 +102,7 @@ func ExampleParsePrintDocument() { | |||
| if err != nil { | |||
| panic(err) | |||
| } | |||
| fmt.Println(out.String()) // Output: query { hello } | |||
There was a problem hiding this comment.
The operation type (query) is no longer part of the output. It wasn't clear to me whether this is intentional or not.
antoineco
commented
Apr 26, 2024
| operationNames = append(operationNames, name) | ||
| operationType := document.RootOperationTypeDefinitions[node.Ref].OperationType |
There was a problem hiding this comment.
RootOperationTypeDefinitions is an empty slice here. Likewise, it wasn't clear to me whether this is intentional or not.
antoineco
commented
Apr 26, 2024
Comment on lines
+502
to
+508
| ChildNodes: plan.TypeFields{ | ||
| { | ||
| TypeName: "Foo", | ||
| FieldNames: []string{"bar"}, | ||
| }, | ||
| }, |
There was a problem hiding this comment.
Without defining child nodes, the plan action fails with
panic: internal: nodesResolvableVisitor: could not select the datasource to resolve Query.foo on a path query.foo
antoineco
commented
Apr 26, 2024
| @@ -560,7 +565,7 @@ func ExampleExecuteOperation() { | |||
| if err != nil { | |||
| panic(err) | |||
| } | |||
| fmt.Println(out.String()) // Output: {"data":{"hello":"world"}} | |||
| fmt.Println(out) // Output: {"data":{"hello":"world"}} | |||
There was a problem hiding this comment.
I am still getting an error instead of the suggested output here:
{"errors":[{"message":"String cannot represent non-string value: \"\"","path":[]}],"data":null}I'll need more time to trace why this is happening, so in case the cause is obvious to someone, feel free to point me in the right direction.
antoineco
force-pushed
the
fix/v2-examples
branch
from
e5a84bf
to
d8f5720
Compare
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.
While going over the tutorial code, I spotted a few mistakes in the sample outputs and method calls.
I'm leaving a few comments on selected changes for consideration.