@@ -237,13 +237,13 @@ defined by this specification.
237
237
238
238
Description : StringValue
239
239
240
- Documentation is a first-class feature of GraphQL by encouraging written
240
+ Documentation is a first-class feature of GraphQL by including written
241
241
descriptions on all named definitions in executable {Document} and GraphQL type
242
242
systems, which is also made available via introspection ensuring the
243
243
documentation of a GraphQL service remains consistent with its capabilities (see
244
244
[ Type System Descriptions] ( #sec-Type-System-Descriptions ) ).
245
245
246
- GraphQL descriptions are expected to provided as Markdown (as specified by
246
+ GraphQL descriptions are provided as Markdown (as specified by
247
247
[ CommonMark] ( https://commonmark.org/ ) ). Description strings (often
248
248
{BlockString}) occur immediately before the definition they describe.
249
249
@@ -279,11 +279,10 @@ fragment TimeMachineDetails on TimeMachine {
279
279
}
280
280
```
281
281
282
- Descriptions and comments in executable GraphQL documents are purely for
283
- documentation purposes. They MUST NOT affect the execution, validation, or
284
- response of a GraphQL document except for type introspection. It is otherwise
285
- safe to remove all descriptions and comments from executable documents without
286
- changing their behavior or results.
282
+ Descriptions in GraphQL executable documents are purely for documentation
283
+ purposes. They MUST NOT affect the execution, validation, or response of a
284
+ GraphQL document. It is safe to remove all descriptions and comments from
285
+ executable documents without changing their behavior or results.
287
286
288
287
## Document
289
288
0 commit comments