Skip to content

Commit b54fe84

Browse files
committed
formatting
1 parent 2236275 commit b54fe84

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

spec/Section 2 -- Language.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,7 @@ defined using the Markdown syntax (as specified by
287287
Descriptions may appear before:
288288

289289
**In type system definitions:**
290+
290291
- Schema definitions.
291292
- Type definitions (scalars, objects, interfaces, unions, enums, input objects).
292293
- Field definitions.
@@ -296,6 +297,7 @@ Descriptions may appear before:
296297
- Directive definitions.
297298

298299
**In executable documents:**
300+
299301
- Operation definitions (queries, mutations, subscriptions) in their full form
300302
(not the shorthand form).
301303
- Fragment definitions.

spec/Section 3 -- Type System.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,18 @@ choose to only allow {TypeSystemExtensionDocument} and not allow
5252

5353
## Type System Descriptions
5454

55-
Documentation is a first-class feature of GraphQL type systems. GraphQL schema and all other definitions (e.g. types, fields, arguments, etc.) which can be described should provide a {Description} unless they are considered self descriptive.
56-
57-
Descriptions in the type system definition language occur immediately before the definition they describe and are made available via introspection, ensuring the documentation of a GraphQL service remains consistent with its capabilities.
58-
59-
Note: See Section 2, "Descriptions", for normative rules and syntax details. Type system descriptions follow the same Markdown format and rules as executable document descriptions.
55+
Documentation is a first-class feature of GraphQL type systems. GraphQL schema
56+
and all other definitions (e.g. types, fields, arguments, etc.) which can be
57+
described should provide a {Description} unless they are considered self
58+
descriptive.
59+
60+
Descriptions in the type system definition language occur immediately before the
61+
definition they describe and are made available via introspection, ensuring the
62+
documentation of a GraphQL service remains consistent with its capabilities.
63+
64+
Note: See Section 2, "Descriptions", for normative rules and syntax details.
65+
Type system descriptions follow the same Markdown format and rules as executable
66+
document descriptions.
6067

6168
## Schema
6269

0 commit comments

Comments
 (0)