Skip to content

Commit 2ff3c93

Browse files
Simplify wording in rule docs (#1310)
* Simplify wording in rule docs * generate d0cs Co-authored-by: Dimitri POSTOLOV <[email protected]>
1 parent daaf762 commit 2ff3c93

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbs
2323
[known-directives](rules/known-directives.md)|A GraphQL document is only valid if all `@directive`s are known by the schema and legally positioned.|![recommended][]|🔮|
2424
[known-fragment-names](rules/known-fragment-names.md)|A GraphQL document is only valid if all `...Fragment` fragment spreads refer to fragments defined in the same document.|![recommended][]|🔮|
2525
[known-type-names](rules/known-type-names.md)|A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.|![recommended][]|🔮|💡
26-
[lone-anonymous-operation](rules/lone-anonymous-operation.md)|A GraphQL document is only valid if when it contains an anonymous operation (the query short-hand) that it contains only that one operation definition.|![recommended][]|🔮|
26+
[lone-anonymous-operation](rules/lone-anonymous-operation.md)|A GraphQL document that contains an anonymous operation (the `query` short-hand) is only valid if it contains only that one operation definition.|![recommended][]|🔮|
2727
[lone-schema-definition](rules/lone-schema-definition.md)|A GraphQL document is only valid if it contains only one schema definition.|![recommended][]|🔮|
2828
[match-document-filename](rules/match-document-filename.md)|This rule allows you to enforce that the file name should match the operation name.|![all][]|🚀|
2929
[naming-convention](rules/naming-convention.md)|Require names to follow specified conventions.|![recommended][]|🚀|💡

docs/rules/lone-anonymous-operation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ enables this rule.
99
- Requires GraphQL Operations: `false`
1010
[ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
1111

12-
A GraphQL document is only valid if when it contains an anonymous operation (the query short-hand)
13-
that it contains only that one operation definition.
12+
A GraphQL document that contains an anonymous operation (the `query` short-hand) is only valid if it
13+
contains only that one operation definition.
1414

1515
> This rule is a wrapper around a `graphql-js` validation function.
1616

packages/plugin/src/rules/graphql-js-validation.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ export const GRAPHQL_JS_VALIDATIONS: Record<string, GraphQLESLintRule> = Object.
411411
{
412412
category: 'Operations',
413413
description:
414-
'A GraphQL document is only valid if when it contains an anonymous operation (the query short-hand) that it contains only that one operation definition.',
414+
'A GraphQL document that contains an anonymous operation (the `query` short-hand) is only valid if it contains only that one operation definition.',
415415
requiresSchema: true,
416416
},
417417
),

0 commit comments

Comments
 (0)