Merge pull request #1810 from mangano-ito/correct-props-table

escape a pipe in table so that row correctly closes
graphql · Mar 17, 2021 · a1b8076 · a1b8076
2 parents b538f6e + d6ffb5b
commit a1b8076
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/packages/graphiql/README.md b/packages/graphiql/README.md
@@ -197,7 +197,7 @@ For more details on props, see the [API Docs](https://graphiql-test.netlify.app/
 | `validationRules`            | `ValidationRule[]`                                                                                    | A array of validation rules that will be used for validating the GraphQL operations. If `undefined` is provided, the default rules (exported as `specifiedRules` from `graphql`) will be used.  |
 | `variables`                  | `string` (JSON)                                                                                       | initial displayed query variables, if `undefined` is provided, the stored variables will be used.                                                                                               |
 | `headers`                    | `string`                                                                                              | initial displayed request headers. if not defined, it will default to the stored headers if `shouldPersistHeaders` is enabled.                                                                  |
-| `externalFragments`          | `string | FragmentDefinitionNode[]`                                                                   | provide fragments external to the operation for completion, validation, and for selective use when executing operations.                                                                        |
+| `externalFragments`          | `string \| FragmentDefinitionNode[]`                                                                  | provide fragments external to the operation for completion, validation, and for selective use when executing operations.                                                                        |
 | `operationName`              | `string`                                                                                              | an optional name of which GraphQL operation should be executed.                                                                                                                                 |
 | `response`                   | `string` (JSON)                                                                                       | an optional JSON string to use as the initial displayed response. If not provided, no response will be initially shown. You might provide this if illustrating the result of the initial query. |
 | `storage`                    | [`Storage`](https://graphiql-test.netlify.app/typedoc/interfaces/graphiql.storage.html)               | **Default:** `window.localStorage`. an interface that matches `window.localStorage` signature that GraphiQL will use to persist state.                                                          |