From 79d1f769b8da8275b7526b62a5f5a03c7000065c Mon Sep 17 00:00:00 2001 From: Sascha Mann Date: Tue, 22 Jun 2021 20:06:14 +0200 Subject: [PATCH 1/5] Add commas after e.g. because American English Co-authored-by: junedev <12543047+junedev@users.noreply.github.com> --- building/markdown/style-guide.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/building/markdown/style-guide.md b/building/markdown/style-guide.md index 9eb96f9e..6703a5cd 100644 --- a/building/markdown/style-guide.md +++ b/building/markdown/style-guide.md @@ -9,7 +9,7 @@ Existing descriptions and test-cases can be updated to adhere to them without re ### Consistency within an exercise -There are some terms that have multiple valid spellings (e.g. "lower case" vs "lowercase"). +There are some terms that have multiple valid spellings (e.g., "lower case" vs "lowercase"). Where a consistent style has not been agreed within this document, these must be consistent within an exercise. ### Exceptions @@ -66,7 +66,9 @@ Some abbreviations are considered common, useful, and non-technical enough that - `etc.` or `etc` - `docs` -Contractions (e.g. "won't", "I'm", "that's") should be used sparingly if at all in exercise descriptions, but are not restricted in other language around the site (e.g. website copy, mentoring). +Contractions (e.g., "won't", "I'm", "that's") should be used sparingly if at all in exercise descriptions, but are not restricted in other language around the site (e.g., website copy, mentoring). + +The abbreviations "i.e." and "e.g." should be followed by a comma in American English (see, e.g., this [StackExchange thread](https://english.stackexchange.com/questions/7946/use-of-e-g-are-parentheses-necessary/93658#93658)). ## Choice of words From 38f975ef30bd450075adc72ab3a347de4da483a6 Mon Sep 17 00:00:00 2001 From: Jeremy Walker Date: Tue, 22 Jun 2021 19:19:15 +0100 Subject: [PATCH 2/5] Update building/markdown/style-guide.md Co-authored-by: Sascha Mann --- building/markdown/style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/building/markdown/style-guide.md b/building/markdown/style-guide.md index 6703a5cd..d3042d3a 100644 --- a/building/markdown/style-guide.md +++ b/building/markdown/style-guide.md @@ -9,7 +9,7 @@ Existing descriptions and test-cases can be updated to adhere to them without re ### Consistency within an exercise -There are some terms that have multiple valid spellings (e.g., "lower case" vs "lowercase"). +There are some terms that have multiple valid spellings (e.g. "lower case" vs "lowercase"). Where a consistent style has not been agreed within this document, these must be consistent within an exercise. ### Exceptions From 9897566606295e1ef89070bf6de3853f328f3031 Mon Sep 17 00:00:00 2001 From: Jeremy Walker Date: Tue, 22 Jun 2021 19:19:33 +0100 Subject: [PATCH 3/5] Update building/markdown/style-guide.md Co-authored-by: Sascha Mann --- building/markdown/style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/building/markdown/style-guide.md b/building/markdown/style-guide.md index d3042d3a..24449fb4 100644 --- a/building/markdown/style-guide.md +++ b/building/markdown/style-guide.md @@ -66,7 +66,7 @@ Some abbreviations are considered common, useful, and non-technical enough that - `etc.` or `etc` - `docs` -Contractions (e.g., "won't", "I'm", "that's") should be used sparingly if at all in exercise descriptions, but are not restricted in other language around the site (e.g., website copy, mentoring). +Contractions (e.g. "won't", "I'm", "that's") should be used sparingly if at all in exercise descriptions, but are not restricted in other language around the site (e.g. website copy, mentoring). The abbreviations "i.e." and "e.g." should be followed by a comma in American English (see, e.g., this [StackExchange thread](https://english.stackexchange.com/questions/7946/use-of-e-g-are-parentheses-necessary/93658#93658)). From 8f868a82c9e33f53ad19cd45c9988d2aeb9de305 Mon Sep 17 00:00:00 2001 From: Jeremy Walker Date: Tue, 22 Jun 2021 19:20:47 +0100 Subject: [PATCH 4/5] Update building/markdown/style-guide.md Co-authored-by: Sascha Mann --- building/markdown/style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/building/markdown/style-guide.md b/building/markdown/style-guide.md index 24449fb4..30af1367 100644 --- a/building/markdown/style-guide.md +++ b/building/markdown/style-guide.md @@ -68,7 +68,7 @@ Some abbreviations are considered common, useful, and non-technical enough that Contractions (e.g. "won't", "I'm", "that's") should be used sparingly if at all in exercise descriptions, but are not restricted in other language around the site (e.g. website copy, mentoring). -The abbreviations "i.e." and "e.g." should be followed by a comma in American English (see, e.g., this [StackExchange thread](https://english.stackexchange.com/questions/7946/use-of-e-g-are-parentheses-necessary/93658#93658)). +While many American English style guides state that the abbreviations "i.e." and "e.g." should be followed by a comma in American English (see, e.g., this [StackExchange thread](https://english.stackexchange.com/questions/7946/use-of-e-g-are-parentheses-necessary/93658#93658)), this is not required in text on Exercism". ## Choice of words From 1c0e95901613b2ed10aae51fc057f0a4911a1bab Mon Sep 17 00:00:00 2001 From: Jeremy Walker Date: Tue, 22 Jun 2021 19:22:05 +0100 Subject: [PATCH 5/5] Update style-guide.md --- building/markdown/style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/building/markdown/style-guide.md b/building/markdown/style-guide.md index 30af1367..1e7bdc7a 100644 --- a/building/markdown/style-guide.md +++ b/building/markdown/style-guide.md @@ -68,7 +68,7 @@ Some abbreviations are considered common, useful, and non-technical enough that Contractions (e.g. "won't", "I'm", "that's") should be used sparingly if at all in exercise descriptions, but are not restricted in other language around the site (e.g. website copy, mentoring). -While many American English style guides state that the abbreviations "i.e." and "e.g." should be followed by a comma in American English (see, e.g., this [StackExchange thread](https://english.stackexchange.com/questions/7946/use-of-e-g-are-parentheses-necessary/93658#93658)), this is not required in text on Exercism". +Many American English style guides state that the abbreviations "i.e." and "e.g." should be followed by a comma (see, e.g., this [StackExchange thread](https://english.stackexchange.com/questions/7946/use-of-e-g-are-parentheses-necessary/93658#93658)). This is permitted, but not required within text on Exercism". ## Choice of words