From 59cecc35d2c80817ac333513bf891071124ae3bf Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Wed, 2 Jul 2025 14:04:21 +0100 Subject: [PATCH 1/2] Minor grammar fix to #1170 --- spec/Section 3 -- Type System.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/Section 3 -- Type System.md b/spec/Section 3 -- Type System.md index 79953a4e0..ed4bdfa8c 100644 --- a/spec/Section 3 -- Type System.md +++ b/spec/Section 3 -- Type System.md @@ -58,7 +58,7 @@ via introspection. [Descriptions](#sec-Descriptions) 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 +GraphQL service. Descriptions may be provided as Markdown (as specified by [CommonMark](https://commonmark.org/)) for every definition in a type system. GraphQL schema and all other definitions (e.g. types, fields, arguments, etc.) From 98eb2b90f462210aa2ae05d4dfa4952598e0e89c Mon Sep 17 00:00:00 2001 From: Lee Byron Date: Wed, 2 Jul 2025 09:01:14 -0700 Subject: [PATCH 2/2] Update Section 3 -- Type System.md slightly stronger --- spec/Section 3 -- Type System.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/Section 3 -- Type System.md b/spec/Section 3 -- Type System.md index ed4bdfa8c..bfe967298 100644 --- a/spec/Section 3 -- Type System.md +++ b/spec/Section 3 -- Type System.md @@ -58,7 +58,7 @@ via introspection. [Descriptions](#sec-Descriptions) allow GraphQL service designers to easily provide documentation which remains consistent with the capabilities of a -GraphQL service. Descriptions may be provided as Markdown (as specified by +GraphQL service. Descriptions should be provided as Markdown (as specified by [CommonMark](https://commonmark.org/)) for every definition in a type system. GraphQL schema and all other definitions (e.g. types, fields, arguments, etc.)