Docs should specify # as comment symbol for GraphQL
#609
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
…ifies double quotations`""` According to the GraphQL spec, '#' are used for comments, not double quotes. See the spec on comments here: https://spec.graphql.org/October2021/#sec-Comments
saihaj
approved these changes
Feb 23, 2024
There was a problem hiding this comment.
personally I would showcase block strings for more explanations but agreed that # should be used for comments as per spec terminology
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.
Currently the graphprotocol docs specify double quotations
""for comments in GraphQL.According to the GraphQL spec, '#' are used for comments, not double quotes. See the GraphQL spec on comments here:
https://spec.graphql.org/October2021/#sec-Comments