Skip to content

Update fragment's definition in Learn-Queries.md - #1586

Open
inlineblock wants to merge 2 commits into
graphql:sourcefrom
inlineblock:inlineblock-graphql-fragments-1
Open

inlineblock wants to merge 2 commits into
graphql:sourcefrom
inlineblock:inlineblock-graphql-fragments-1

Conversation

@inlineblock

Copy link
Copy Markdown

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.

Changing the wording on the description of fragments to nudge people towards a more clear usage, like what Relay.dev does.
@linux-foundation-easycla

linux-foundation-easycla Bot commented Oct 13, 2023

Copy link
Copy Markdown

CLA Signed

The committers listed above are authorized under a signed CLA.

@ghost

ghost commented Oct 13, 2023

Copy link
Copy Markdown

✅ graphql.github.io-source deploy preview ready

@benjie benjie left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

Comment thread src/content/learn/Learn-Queries.md Outdated
Updating the comment to be correct and clear.

Co-authored-by: Benjie <benjie@jemjie.com>
@inlineblock
inlineblock requested a review from benjie October 16, 2023 18:15
@inlineblock

Copy link
Copy Markdown
Author

@benjie thank you for the review! I can do a follow PR to rename the fragment across the document.

@saihaj

saihaj commented Sep 16, 2026

Copy link
Copy Markdown
Member

Hey @inlineblock can you please rebase this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants