Update fragment's definition in Learn-Queries.md #1586
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
Changing the wording on the description of fragments to nudge people towards a more clear usage, like what Relay.dev does.
✅ graphql.github.io-source deploy preview ready
|
benjie
requested changes
Oct 14, 2023
There was a problem hiding this comment.
Looks like a great improvement to me! My one comment is the text describes a comparison page rendering two characters side by side, so it’s the “character” component that would have the fragment I think. Maybe renaming the fragment would make sense but I’ve not looked at the rest of the document; for now I suggest a tiny tweak to your edits.
Updating the comment to be correct and clear. Co-authored-by: Benjie <benjie@jemjie.com>
|
@benjie thank you for the review! I can do a follow PR to rename the fragment across the document. |
benjie
approved these changes
Oct 17, 2023
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.
Updating the wording on how fragment should be used to nudge people towards a more scalable approach of using fragments to define data requirements.
Description
Even though the spec allows fragments to be used however people see fit, the document should nudge people towards a better usage pattern that scales well. In this case, attempt to describe them as composable pieces of data requirements used by UI or utility code. I hope this isn't controversial.