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

doc: fix multiple operations example in readme #497

Merged
merged 1 commit into from
Oct 24, 2024

Conversation

obayemi
Copy link
Contributor

@obayemi obayemi commented Oct 7, 2024

In the graphql file specified in the readme for the multiple operation part, the operations are called Heights and Echo, while the struct is called UnionQuery and the text states that

Note that the struct and the operation in the GraphQL file must have the same name.

I think that's either a confusing oversight or a mistake

@obayemi
Copy link
Contributor Author

obayemi commented Oct 7, 2024

it would probably be a good Idea to add in the begining a readme an example of a schema / query ? or just for this specific example, at least add an explanation that says that the operations in this specific file are called Heights and Echo without needing to check the linked gql file

Copy link
Member

@tomhoule tomhoule left a comment

Choose a reason for hiding this comment

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

Good catch!

@tomhoule tomhoule merged commit e4b37c4 into graphql-rust:main Oct 24, 2024
8 of 9 checks passed
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