[docs] fix markdown issue in fragments.md #3408
Closed
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
poteto
reviewed
Mar 16, 2021
| @@ -85,7 +85,7 @@ Let's distill what's going on here: | |||
| * A *fragment reference* is an object that Relay uses to *read* the data declared in the fragment definition; as you can see, the `UserComponent_user` fragment itself just declares fields on the `User` type, but we need to know *which* specific user to read those fields from; this is what the fragment reference corresponds to. In other words, a fragment reference ** is like *a pointer to a specific instance of a type* that we want to read data from. | |||
| * Note that *the component is automatically subscribed to updates to the fragment data*: if the data for this particular `User` is updated anywhere in the app (e.g. via fetching new data, or mutating existing data), the component will automatically re-render with the latest updated data. | |||
| * Relay ** will automatically generate Flow types for any declared fragments when the compiler is run, so you can use these types to declare the type for your Component's `props`. | |||
| * The generated Flow types include a type for the fragment reference, which is the type with the `$key` suffix: ``*<fragment_name>*``$key``, and a type for the shape of the data, which is the type with the `$data` suffix: ``*<fragment_name>*``$data``; these types are available to import from files that are generated with the following name: `*<fragment_name>*.graphql.js`. | |||
| * The generated Flow types include a type for the fragment reference, which is the type with the `$key` suffix: `*<fragment_name>*$key`, and a type for the shape of the data, which is the type with the `$data` suffix: `*<fragment_name>*$data`; these types are available to import from files that are generated with the following name: `*<fragment_name>*.graphql.js`. | |||
There was a problem hiding this comment.
You can generally drop these *s within the backticks: they're a formatting quirk from our internal doc tool which used to allow us to bold/italicize code blocks. We can just drop them here.
There was a problem hiding this comment.
Got it. I'll remove those *s and **s. Thought the *<>* was some sort of syntax highlight. 😅
poteto
reviewed
Mar 16, 2021
| @@ -85,7 +85,7 @@ Let's distill what's going on here: | |||
| * A *fragment reference* is an object that Relay uses to *read* the data declared in the fragment definition; as you can see, the `UserComponent_user` fragment itself just declares fields on the `User` type, but we need to know *which* specific user to read those fields from; this is what the fragment reference corresponds to. In other words, a fragment reference ** is like *a pointer to a specific instance of a type* that we want to read data from. | |||
There was a problem hiding this comment.
Do you mind removing these stray **s too?
There was a problem hiding this comment.
Thanks for pointing that out. All *s and **s are dropped! 8b21be8
There was a problem hiding this comment.
@poteto has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
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, this doesn't render right:
The change:
The generated Flow types include a type for the fragment reference, which is the type with the
$keysuffix:<fragment_name>$key, and a type for the shape of the data, which is the type with the$datasuffix:<fragment_name>$data; these types are available to import from files that are generated with the following name:<fragment_name>.graphql.js