Skip to content

add note about selection sets in serial execution examples #926

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

Conversation

thomasheyenbrock
Copy link
Contributor

The examples for serial execution in the section Normal and Serial Execution actually use a query as operation type. This PR proposes to change these examples to mutations (which are actually required to be executed serially).

I also added in the variables in the first of these examples for the operation to be valid.

@netlify
Copy link

netlify bot commented Jan 24, 2022

✔️ Deploy Preview for graphql-spec-draft ready!

🔨 Explore the source changes: 321255e

🔍 Inspect the deploy log: https://app.netlify.com/sites/graphql-spec-draft/deploys/61fbe769d4671a0008c647fc

😎 Browse the preview: https://deploy-preview-926--graphql-spec-draft.netlify.app

Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

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

Thanks for submitting a suggestion 🙌

The spec text here states (emphasis mine):

For example, given the following selection set to be executed serially:

The examples are not GraphQL documents, they are selection sets, your edits turn them into documents but that change is not desired.

@thomasheyenbrock
Copy link
Contributor Author

Aaah, got it 👍 Though it's easy to read over that and there's a bit of ambiguity here in the sense that one can't tell the difference from a selection set to a document using the query shorthand. What do you think about adding a note here to clear this up?

@benjie
Copy link
Member

benjie commented Feb 3, 2022

What do you think about adding a note here to clear this up?

Let's see what you have in mind 👍

@thomasheyenbrock thomasheyenbrock force-pushed the editorial/serial-execution-examples branch from 053e94d to 321255e Compare February 3, 2022 14:32
@thomasheyenbrock thomasheyenbrock changed the title use mutations in examples for serial execution add note about selection sets in serial execution examples Feb 3, 2022
@thomasheyenbrock
Copy link
Contributor Author

Updated the PR description and replaced the commit with a new one that just adds a note 🙂

@benjie
Copy link
Member

benjie commented Feb 3, 2022

I'm not convinced this is necessary given the text above the example explicitly states selection set, but I'll let others comment 👍

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