Skip to content

Commit 9c5100c

Browse files
deploy: b1a23de
1 parent 51252cf commit 9c5100c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

draft/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1541,7 +1541,7 @@ <h2 data-source="spec/Section%203%20--%20Type%20System.md#L30"><span class="spec
15411541
<section id="sec-Type-System-Descriptions" secid="3.2">
15421542
<h2 data-source="spec/Section%203%20--%20Type%20System.md#L53"><span class="spec-secid" title="link to this section"><a href="#sec-Type-System-Descriptions">3.2</a></span>Type System Descriptions</h2>
15431543
<p data-source="spec/Section%203%20--%20Type%20System.md#L55-L57">Documentation is a first-class feature of GraphQL type systems, written immediately alongside definitions in a <span class="spec-nt"><a href="#TypeSystemDocument" data-name="TypeSystemDocument">TypeSystemDocument</a></span> and made available via introspection.</p>
1544-
<p data-source="spec/Section%203%20--%20Type%20System.md#L59-L62"><a href="#sec-Descriptions">Descriptions</a> allow GraphQL service designers to easily provide documentation which remains consistent with the capabilities of a GraphQL service. Descriptions provided as Markdown (as specified by <a href="https://commonmark.org/">CommonMark</a>) for every definition in a type system.</p>
1544+
<p data-source="spec/Section%203%20--%20Type%20System.md#L59-L62"><a href="#sec-Descriptions">Descriptions</a> allow GraphQL service designers to easily provide documentation which remains consistent with the capabilities of a GraphQL service. Descriptions should be provided as Markdown (as specified by <a href="https://commonmark.org/">CommonMark</a>) for every definition in a type system.</p>
15451545
<p data-source="spec/Section%203%20--%20Type%20System.md#L64-L66">GraphQL schema and all other definitions (e.g. types, fields, arguments, etc.) which can be described should provide a <span class="spec-nt"><a href="#Description" data-name="Description">Description</a></span> unless they are considered self descriptive.</p>
15461546
<p data-source="spec/Section%203%20--%20Type%20System.md#L68">As an example, this simple GraphQL schema is well described:</p>
15471547
<pre id="example-916f4" class="spec-example" data-language="graphql" data-source="spec/Section%203%20--%20Type%20System.md#L70-L110"><a href="#example-916f4">Example № 37</a><code><span class="token description string">"""<span class="token language-markdown">

0 commit comments

Comments
 (0)