Skip to content

Commit bcd5c07

Browse files
itamarkfacebook-github-bot
authored andcommitted
Fix broken markdown in FbInternalOnly blocks
Reviewed By: captbaritone Differential Revision: D69719271 fbshipit-source-id: 2ada93f5911aa7535c74705a4fa96572fbbc5cbc
1 parent 9f20e6d commit bcd5c07

File tree

34 files changed

+115
-0
lines changed

34 files changed

+115
-0
lines changed

website/docs/api-reference/graphql/graphql-directives.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ code and are removed from requests sent to your GraphQL server.
2626
**Note:** The Relay compiler will maintain any directives supported by your server (such as `@include` or `@skip`) so they remain part of the request to the GraphQL server and won't alter generated runtime artifacts.
2727
</OssOnly>
2828
<FbInternalOnly>
29+
2930
**Note:** The Relay compiler will maintain any directives supported by your server (such as `@include` or `@skip`) so they remain part of the request to the GraphQL server and won't alter generated runtime artifacts. Additional directives are documented [here](https://www.internalfb.com/intern/wiki/GraphQL/APIs_and_References/Directives/#graphql-standard).
31+
3032
</FbInternalOnly>
3133

3234
## `@arguments`

website/docs/getting-started/compiler.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ This would produce three generated files, and two `__generated__` directories:
146146
### Importing generated definitions
147147

148148
<FbInternalOnly>
149+
149150
<FbImportingGeneratedDefinitions />
150151

151152
</FbInternalOnly>

website/docs/glossary/glossary.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,9 @@ A directive which declares that a field implements the [connection](#connection)
144144
## Connection
145145

146146
<FbInternalOnly>
147+
147148
A field implementing the [connection spec](https://relay.dev/graphql/connections.htm). See <a href="https://www.internalfb.com/intern/wiki/Graphql-connections-for-hack-developers/Connection-spec/">here</a> for more details on the spec, and the section of the guided tour on <a href="../guided-tour/list-data/pagination/">rendering list data and pagination</a>.
149+
148150
</FbInternalOnly>
149151

150152
<OssOnly>
@@ -186,7 +188,9 @@ See the [Thinking in Relay guide](../principles-and-architecture/thinking-in-rel
186188
A directive which can be added to a fragment spread or inline fragment to avoid blocking on that fragment's data. For more detail refer to GraphQL's [documentation on the @defer directive](https://github.com/graphql/graphql-wg/blob/main/rfcs/DeferStream.md#defer).
187189

188190
<FbInternalOnly>
191+
189192
See [Incremental Data Delivery](https://www.internalfb.com/intern/staticdocs/relay/docs/guides/incremental-data-delivery/).
193+
190194
</FbInternalOnly>
191195

192196
## Definition
@@ -496,7 +500,9 @@ TODO
496500
A mutation is a combination of two things: a mutation on the backend, followed by query against updated data.
497501
498502
<FbInternalOnly>
503+
499504
See the [guide on mutations](../guided-tour/updating-data/graphql-mutations), and [this article](https://www.internalfb.com/intern/wiki/Graphql-for-hack-developers/mutation-root-fields/) on defining mutations in your hack code.
505+
500506
</FbInternalOnly>
501507
502508
<OssOnly>
@@ -636,7 +642,9 @@ Required because of current limitations on dynamically loading components in Rea
636642
For Relay to process a file with a GraphQL literal, it must be included in a project. A project specifies the folders to which it applies and the schema against which to evaluate GraphQL literals, and includes other information needed by the Relay compiler.
637643
638644
<FbInternalOnly>
645+
639646
Projects are defined in a single [config](#config) file, found [here](https://www.internalfb.com/intern/diffusion/WWW/browse/master/scripts/relay/compiler-rs/config.www.json) and [here](https://www.internalfb.com/intern/diffusion/FBS/browse/master/xplat/relay/compiler-rs/config.xplat.json).
647+
640648
</FbInternalOnly>
641649
642650
## Profiler
@@ -855,6 +863,7 @@ TODO
855863
A collection of all of the GraphQL types that are known to Relay, for a given [project](#project).
856864
857865
<FbInternalOnly>
866+
858867
## Schema Sync
859868
860869
The GraphQL [schema](#schema) is derived from annotations on Hack classes in the www repository.

website/docs/guides/relay-resolvers/defining-types.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,9 @@ interface IUser {
125125

126126
You could define two (or more) concrete resolver types that implement the IUser interface by adding annotations in the docblock (the same applies for unions).
127127
<FbInternalOnly>
128+
128129
Note, support for abstract types is not available for relay resolvers in Flow syntax (yet).
130+
129131
</FbInternalOnly>
130132

131133
<Tabs

website/docs/guides/relay-resolvers/enabling.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,5 @@ const environment = new Environment({
3737
To opt-in the new syntax in a file, add `//relay:enable-new-relay-resolver` to the file
3838

3939
To convert files to the new syntax, run codemode: `flow-runner codemod relay/migrateResolver <path>`. The codemod doesn't support all cases, so you might need to modify some files manually after it runs.
40+
4041
</FbInternalOnly>

website/docs/guides/required-directive.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,9 @@ fragment MyFrag on Actor {
180180
In this situation Relay will generate a union type like: `{__typename: 'User', name: string} | {__typename: '%ignore this%}`. Now you can check the `__typename` field to narrow your object's type down to one that has a non-nullable `name`.
181181

182182
<FbInternalOnly>
183+
183184
Example diff showing the adoption of this strategy: D24370183
185+
184186
</FbInternalOnly>
185187

186188
### Why not implement this at the schema/server level?
@@ -197,6 +199,7 @@ Basically every value returned by Relay is nullable. This is intentional since w
197199

198200
_Extracted from [this comment thread](https://fb.workplace.com/groups/cometeng/permalink/937671436726844/?comment_id=937681186725869)._
199201
_Further discussion in [this comment thread](https://fb.workplace.com/groups/cometeng/permalink/937671436726844/?comment_id=938335873327067)._
202+
200203
</FbInternalOnly>
201204

202205
### Can `(action: NONE)` be the default?

website/docs/guides/testing-relay-components.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ With the `MockPayloadGenerator` and `@relay_test_operation`, we want to get rid
5757
**[React Testing Library](https://testing-library.com/react)** is a set of helpers that let you test React components without relying on their implementation details. This approach makes refactoring a breeze and also nudges you towards best practices for accessibility. Although it doesn't provide a way to "shallowly" render a component without its children, a test runner like Jest lets you do this by [mocking](https://reactjs.org/docs/testing-recipes.html#mocking-modules).
5858

5959
<FbInternalOnly>
60+
6061
Note: The [`ReactTestRenderer`](https://www.npmjs.com/package/react-test-renderer) library has been deprecated since React v18. `ReactTestRenderer` may still be referenced internally as an alternative to React Testing Library. However, when possible, we recommend using React Testing Library (or `@testing-library/react-native`) to test your React applications with Relay.
62+
6163
</FbInternalOnly>
6264

6365
## RelayMockEnvironment API Overview

website/docs/tutorial/refetchable-fragments.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,9 @@ import {OssOnly, FbInternalOnly} from 'docusaurus-plugin-internaldocs-fb/interna
336336
Besides fragments on types that implement `Node`, you can also refetch fragments that are on `Viewer` (since the viewer is assumed to be stable throughout a session) and that are at the top level of a query (since there’s no field above them that could change identity).
337337

338338
<FbInternalOnly>
339+
339340
Meta only: Ents marked with <a href="https://fb.workplace.com/groups/graphql.fyi/permalink/1539541276187011/" target="_blank">GraphQLFetchable</a> can also be refetched.
341+
340342
</FbInternalOnly>
341343

342344
</details>

website/versioned_docs/version-v13.0.0/glossary/glossary.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,9 @@ A directive which declares that a field implements the [connection](#connection)
133133
## Connection
134134

135135
<FbInternalOnly>
136+
136137
A field implementing the connection spec. See <a href="https://www.internalfb.com/intern/wiki/Graphql-connections-for-hack-developers/Connection-spec/">here</a> for more details on the spec, and the section of the guided tour on <a href="../guided-tour/list-data/pagination/">rendering list data and pagination</a>.
138+
137139
</FbInternalOnly>
138140

139141
<OssOnly>
@@ -419,7 +421,9 @@ TODO
419421
A mutation is a combination of two things: a mutation on the backend, followed by query against updated data.
420422
421423
<FbInternalOnly>
424+
422425
See the [guide on mutations](../guided-tour/updating-data/graphql-mutations), and [this article](https://www.internalfb.com/intern/wiki/Graphql-for-hack-developers/mutation-root-fields/) on defining mutations in your hack code.
426+
423427
</FbInternalOnly>
424428
425429
<OssOnly>
@@ -539,7 +543,9 @@ Required because of current limitations on dynamically loading components in Rea
539543
For Relay to process a file with a GraphQL literal, it must be included in a project. A project specifies the folders to which it applies and the schema against which to evaluate GraphQL literals, and includes other information needed by the Relay compiler.
540544
541545
<FbInternalOnly>
546+
542547
Projects are defined in a single [config](#config) file, found [here](https://www.internalfb.com/intern/diffusion/WWW/browse/master/scripts/relay/compiler-rs/config.www.json) and [here](https://www.internalfb.com/intern/diffusion/FBS/browse/master/xplat/relay/compiler-rs/config.xplat.json).
548+
543549
</FbInternalOnly>
544550
545551
## Profiler
@@ -735,6 +741,7 @@ TODO
735741
A collection of all of the GraphQL types that are known to Relay, for a given [project](#project).
736742
737743
<FbInternalOnly>
744+
738745
## Schema Sync
739746
740747
The GraphQL [schema](#schema) is derived from annotations on Hack classes in the www repository.

website/versioned_docs/version-v13.0.0/guides/required-directive.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,9 @@ fragment MyFrag on Actor {
119119
In this situation Relay will generate a union type like: `{__typename: 'User', name: string} | {__typename: '%ignore this%}`. Now you can check the `__typename` field to narrow your object's type down to one that has a non-nullable `name`.
120120

121121
<FbInternalOnly>
122+
122123
Example diff showing the adoption of this strategy: D24370183
124+
123125
</FbInternalOnly>
124126

125127
### Why not implement this at the schema/server level?

0 commit comments

Comments
 (0)