Skip to content

Commit f2b1b1f

Browse files
committed
Editorial
1 parent 369dc2b commit f2b1b1f

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

spec/Section 1 -- Overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ GraphQL has a number of design principles:
6363
endpoints. A GraphQL response, on the other hand, contains exactly what a
6464
client asks for and no more.
6565

66-
- **Introspective**: GraphQL is introspective and self-describing. A GraphQL
66+
- **Self-describing**: GraphQL is self-describing and introspective. A GraphQL
6767
service's type system can be queryable by the GraphQL language itself, which
6868
includes readable documentation. GraphQL introspection serves as a powerful
6969
platform for building common developer tools and client software libraries.

spec/Section 2 -- Language.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -237,13 +237,13 @@ defined by this specification.
237237

238238
Description : StringValue
239239

240-
Documentation is a first-class feature of GraphQL by encouraging written
240+
Documentation is a first-class feature of GraphQL by including written
241241
descriptions on all named definitions in executable {Document} and GraphQL type
242242
systems, which is also made available via introspection ensuring the
243243
documentation of a GraphQL service remains consistent with its capabilities (see
244244
[Type System Descriptions](#sec-Type-System-Descriptions)).
245245

246-
GraphQL descriptions are expected to provided as Markdown (as specified by
246+
GraphQL descriptions are provided as Markdown (as specified by
247247
[CommonMark](https://commonmark.org/)). Description strings (often
248248
{BlockString}) occur immediately before the definition they describe.
249249

@@ -279,11 +279,10 @@ fragment TimeMachineDetails on TimeMachine {
279279
}
280280
```
281281

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.
287286

288287
## Document
289288

spec/Section 6 -- Execution.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ chosen by the implementing service.
3535

3636
Note: Descriptions and comments in executable documents (operation definitions,
3737
fragment definitions, and variable definitions) MUST be ignored during execution
38-
and have no effect on the execution, validation, or response of a GraphQL
39-
document. Descriptions and comments on executable documents MAY be used for
40-
observability and logging purposes.
38+
and have no effect on the observable execution, validation, or response of a
39+
GraphQL document. Descriptions and comments on executable documents MAY be used
40+
for non-observable purposes, such as logging and other developer tools.
4141

4242
## Executing Requests
4343

0 commit comments

Comments
 (0)