Skip to content

Commit a47c221

Browse files
committed
another round of clarification
1 parent 7fbb948 commit a47c221

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

spec/Appendix B -- Notation Conventions.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,8 @@ entry has a unique key, and can be directly referenced by that key.
248248
ordered map, which does not have an entry with that key, is ordered after
249249
existing entries.
250250

251-
Note: Ordered data collection are only specified when strictly necessary. To
252-
improve legibility and stability of outputs it is recommended to preserve
253-
observable order. For example if applying a grammar to an input string produces
254-
a set, serializing that set should reproduce the original order.
251+
Note: This specification defines ordered data collection only when strictly
252+
necessary. When an order is observable, implementations should preserve it to
253+
improve output legibility and stability. For example if applying a grammar to an
254+
input string yields a sequence of elements, serialization should emit those
255+
elements in the same source order.

spec/Section 4 -- Introspection.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,11 @@ warnings.
119119

120120
**Stable Ordering**
121121

122-
To improve legibility and stability of schema representations, it is recommended
123-
to preserve observable order for all data collections. For example, if a schema
124-
was produced from a source {TypeSystemDocument} then introspection of fields,
125-
input fields, arguments, enum values, directives, union members, implemented
126-
interfaces and so on should reproduce the original order.
122+
The observable order of all data collections should be preserved to improve
123+
schema legibility and stability. When a schema is produced from a
124+
{TypeSystemDocument}, introspection should return items in the same source order
125+
for each element list: object fields, input object fields, arguments, enum
126+
values, directives, union member types, and implemented interfaces.
127127

128128
**Schema Introspection Schema**
129129

0 commit comments

Comments
 (0)