From ac3da611f219dbfbbe057a74ed5cea1962b14d3e Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Tue, 25 Feb 2025 11:26:37 +0100 Subject: [PATCH 1/4] add tone of voice --- STYLE_GUIDE.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index 7ee0e2915..d4a9fe45f 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -82,3 +82,16 @@ MyAlgorithm(argOne, argTwo): - Let {something} be {true}. - Return {something}. ``` + +## Tone of voice + +The GraphQL specification is a reference document and should use neutral and +descriptive tone of voice. + +Favor the present tense. The present tense is usually clearer and shorter: + +✅ Present: The client then sends a request to the server. +❌ Future: The client will then send a request to the server. + +Avoid repetition. Repetition adds more cognitive load and possibilities for different +parts of the specification to diverge in their meaning. From 5294d1d466b086465db7f9645d7fbf1958a13f6e Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Tue, 25 Feb 2025 14:16:18 +0100 Subject: [PATCH 2/4] format --- STYLE_GUIDE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index d4a9fe45f..4a257a38d 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -90,8 +90,8 @@ descriptive tone of voice. Favor the present tense. The present tense is usually clearer and shorter: -✅ Present: The client then sends a request to the server. -❌ Future: The client will then send a request to the server. +✅ Present: The client then sends a request to the server. ❌ Future: The client +will then send a request to the server. -Avoid repetition. Repetition adds more cognitive load and possibilities for different -parts of the specification to diverge in their meaning. +Avoid repetition. Repetition adds more cognitive load and possibilities for +different parts of the specification to diverge in their meaning. From 0cde790c0d473e47574dba6bdde916865fe9e66e Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Tue, 25 Feb 2025 14:18:57 +0100 Subject: [PATCH 3/4] fix formating --- STYLE_GUIDE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index 4a257a38d..34d83c16f 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -90,8 +90,9 @@ descriptive tone of voice. Favor the present tense. The present tense is usually clearer and shorter: -✅ Present: The client then sends a request to the server. ❌ Future: The client -will then send a request to the server. +✅ Present: The client then sends a request to the server. + +❌ Future: The client will then send a request to the server. Avoid repetition. Repetition adds more cognitive load and possibilities for different parts of the specification to diverge in their meaning. From 3a1cc03824fad23fa1058122ce262d07db5b5744 Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Tue, 25 Feb 2025 14:19:56 +0100 Subject: [PATCH 4/4] formatting --- STYLE_GUIDE.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index 34d83c16f..d99ddceaa 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -88,11 +88,15 @@ MyAlgorithm(argOne, argTwo): The GraphQL specification is a reference document and should use neutral and descriptive tone of voice. -Favor the present tense. The present tense is usually clearer and shorter: +**Favor the present tense** + +The present tense is usually clearer and shorter: ✅ Present: The client then sends a request to the server. ❌ Future: The client will then send a request to the server. -Avoid repetition. Repetition adds more cognitive load and possibilities for -different parts of the specification to diverge in their meaning. +**Avoid repetition** + +Repetition adds more cognitive load and possibilities for different parts of the +specification to diverge in their meaning.