Skip to content

Commit eb4abf3

Browse files
axtensiHiD
andauthored
Spelling suggestions (#146)
* Spelling suggestions * Apply suggestions from code review Co-authored-by: Jeremy Walker <[email protected]>
1 parent c329874 commit eb4abf3

29 files changed

+45
-45
lines changed

building/markdown/markdown.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ All rules are being added to our CI and linting tools, and should be adhered to
1111
- All files must start start with a level-1 heading (`# Some heading text`).
1212
- Level-1 headings exist purely for consuming on GitHub or equivalent.
1313
- If the file is rendered by Exercism (e.g. displayed on the website, rendered via the CLI), this heading will be removed, and a contextual heading will be inserted.
14-
- No heading may decend a level greater than one below the previous (e.g. `##` may only be followed by `###`, not `####`).
14+
- No heading may descend a level greater than one below the previous (e.g. `##` may only be followed by `###`, not `####`).
1515
- Beyond the single level-1 (`#`) heading, only level-2 (`##`), level-3 (`###`) and level-4 (`####`) headings may be used.
1616

1717
## Links

building/tooling/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Tooling is (generally) written in the language of the specific track, and is bui
77

88
All tooling is deployed using the same Docker workflow.
99

10-
There are currently three pices of tooling:
10+
There are currently three pieces of tooling:
1111

1212
- **[Test Runners](./test-runners)**
1313
- **[Representers](./representers)**

building/tooling/analyzers/interface.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ The following `type`s are valid:
7373
Comments without a type field default to `informative `.
7474

7575
Currently in the website, we soft-block on essential comments, encourage students to complete actionable comments before marking as complete on Practice Exercises (but not Concept Exercises), but don't suggest any action on `informative` or `celebratory`.
76-
However, in the future we may choose to add emojis or indicators to other types, or group them seperately.
76+
However, in the future we may choose to add emojis or indicators to other types, or group them separately.
7777

7878
## Debugging
7979

@@ -139,9 +139,9 @@ In this document, **de facto** is defined as follows:
139139
position by public acceptance or market forces. Unofficial customs that are
140140
widely accepted.
141141

142-
In other words, if a nearly all developers (non-hobyists) who write code in a
142+
In other words, if a nearly all developers (non-hobbyists) who write code in a
143143
certain language have established certain rules, these rules are a **de facto
144-
standard** and become idiomatic use. Example: **Ruby** uses 2 space identation.
144+
standard** and become idiomatic use. Example: **Ruby** uses 2 space indentation.
145145

146146
Some rules are language features, even if they are not documented well. These
147147
language features are part of "idiomatic rules" and not stylistic choices.
@@ -197,7 +197,7 @@ to the official rules.
197197
> - :speech*balloon: if it's a \_stylistic* preference, **and** there is _one
198198
> clear standard_, comment on it. These rules enforce idiomatic code.
199199
> - :question: If it's a _stylistic_ preference, **and** there is no clear
200-
> standard, but most to all non-hobyist have adopted the same style, this
200+
> standard, but most to all non-hobbyist have adopted the same style, this
201201
> might be idiomatic. Comment at your discretion.
202202
203203
#### Examples

building/tooling/docker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ It should live at the root directory of your repository and should be called `Do
77

88
The Dockerfile should create the minimal image needed for the tooling to function correctly and speedily.
99

10-
The Dockerfile should produce an image with as a small a size as possible while maximising (and prioritising) perfomance.
10+
The Dockerfile should produce an image with as a small a size as possible while maximising (and prioritising) performance.
1111
Applying the official [Dockerfile best practices](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/) can help to create a minimal image.
1212

1313
## Execution
@@ -53,7 +53,7 @@ To use the internal network, first run `docker network create --internal interna
5353

5454
### Memory
5555

56-
Languages can set the maximum memory they need to use to run their jobs. Setting this to be as low as possible means that we can run more jobs more quickly in parallel. It also means that people who try and abuse memory will not be able to succeed. Different langauges need wildly different maximum memory usage. Benchmarking the execution of a docker run to establish the maximum memory it uses is advised and appreciated.
56+
Languages can set the maximum memory they need to use to run their jobs. Setting this to be as low as possible means that we can run more jobs more quickly in parallel. It also means that people who try and abuse memory will not be able to succeed. Different languages need wildly different maximum memory usage. Benchmarking the execution of a docker run to establish the maximum memory it uses is advised and appreciated.
5757

5858
Memory [should be specified](https://docs.docker.com/config/containers/resource_constraints/#limit-a-containers-access-to-memory) using the number with suffix of b, k, m, g, to indicate bytes, kilobytes, megabytes, or gigabytes.
5959

building/tooling/representers/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ A notification will be sent for old solutions with a matching representation.
2525
Each language has it's own representer, written in that language.
2626
The website acts as the orchestrator between the representer and students' submissions.
2727

28-
Each representer lives in the Exercism GitHub organsation in a repository named `$LANG-representer` (e.g. `ruby-representer`).
28+
Each representer lives in the Exercism GitHub organisation in a repository named `$LANG-representer` (e.g. `ruby-representer`).
2929
You can explore the different representers [here](https://github.com/exercism?q=-representer).
3030

3131
If you would like to get involved in helping with an existing Representer, please open an issue in its repository asking if there is somewhere you can help.

building/tooling/test-runners/interface.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ The per-test `output` key should be used to store and output anything that a use
138138
- It should be attached to all test results that produce user output.
139139
- Only content outputted by a user manually should show - not automatic output by the test-runner.
140140
- You may either capture content that is output through normal means (e.g. `puts` in Ruby, `print` in Python or `Debug.WriteLine` in C#), or you may provide a method that the user may use (e.g. the Ruby Test Runner provides a user with a globally available `debug` method that they can use, which has the same characteristics as the standard `puts` method).
141-
- The output **must** be limited to 500 chars. Either truncating with a message of "Output was truncated. Please limit to 500 chars" or returning an error in this situation are acceptible.
141+
- The output **must** be limited to 500 chars. Either truncating with a message of "Output was truncated. Please limit to 500 chars" or returning an error in this situation are acceptable.
142142

143143
### UI/UX concerns
144144

@@ -168,6 +168,6 @@ Test Code:
168168
All roads lead to Rome and there is no prescribed pattern to arrive at this.
169169
There are several approaches taken so far:
170170

171-
- Auxillary JSON files compiled manually, merged with test results during the test run-time.
171+
- Auxiliary JSON files compiled manually, merged with test results during the test run-time.
172172
- Automated static analysis of the test suite, merged with test results during the test run-time.
173173
- This may be accomplished by AST analysis or text-parsing

building/tracks/ci/workflow-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ It can be very helpful to make the actions that should run, available locally as
5252

5353
> "But the command is very short, e.g. `eslint . --ext ts --ext tsx`".
5454
>
55-
> When this command needs to be updated, it now needs to update in all the places in the documentation, the workflow files, ánd in the _minds of the maintainers_. Extracting this to a script resolves all that. Reading a workflow file can also be **very** daunting.
55+
> When this command needs to be updated, it now needs to update in all the places in the documentation, the workflow files, and in the _minds of the maintainers_. Extracting this to a script resolves all that. Reading a workflow file can also be **very** daunting.
5656
5757
### Checks on PRs where exercises change
5858

building/tracks/concept-exercises.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ my_first_variable = SomeComplexObject.new
126126

127127
The `introduction.md` document introduces the exercise's concept(s) to the student. Each concept also has its _own_ [`introduction.md` document](./concepts#fileintroductionmd), which is not shown outside the context of an exercise.
128128

129-
If the concept's introduction should be included verbatim in the exercise's introduction, an `introduction.md.tpl` file can be used. This file allows refering to concept introductions through placeholders: `%{concept:<concept-slug>}`.
129+
If the concept's introduction should be included verbatim in the exercise's introduction, an `introduction.md.tpl` file can be used. This file allows referring to concept introductions through placeholders: `%{concept:<concept-slug>}`.
130130

131131
[configlet](./configlet/generating.md) can generate an `introduction.md` file from a template file. The generated file will have the concept placeholders replaced by the concept's `introduction.md` contents.
132132

@@ -166,7 +166,7 @@ We place high value on making Exercism's content safe for everyone and so often
166166

167167
- Try to make sure the story is welcoming and can be understood by everyone. If the story contains in-jokes or regional slang, try to think of alternative phrases.
168168
- Try to write examples that are inclusive to everyone. For example, consider using names from other cultures and mixed genders.
169-
- Ask yourself whether you know anyone personally who would take offense by the story. If that's the case, consider changing it to avoid it.
169+
- Ask yourself whether you know anyone personally who would take offence by the story. If that's the case, consider changing it to avoid it.
170170

171171
#### Example
172172

@@ -476,7 +476,7 @@ Each exercise also has a _slug_, which is normalized version of the exercise nam
476476

477477
1. Use lowercase.
478478
1. Use [kebab-case][kebab-case].
479-
1. Use latin alphanumerical characters and dashes (Regexp: `[a-z0-9-]+`)
479+
1. Use Latin alphanumerical characters and dashes (Regexp: `[a-z0-9-]+`)
480480
1. Prefer written digits over numeric ones, unless there is a specific reason to prefer the digit (e.g. `two-fer` over `2-fer`)
481481

482482
Good examples of slugs:

building/tracks/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Here some examples of what could be covered.
7575
- Performance characteristics and memory usage, when a common consideration within that language
7676
- Don't refer to an exercise in the text, as this file is displayed outside the context of an exercise.
7777

78-
It is **not** the aim of the `about.md` file to provide a complete set of information on the Concept. As an example, imagine a language that has some older features for which experienced programmers (and maybe even the official docs/specs) recommend they should not be used anymore. Providing details on such features would be out of scope for the `about.md` file because they are not relevant to gain fluency. However, maintainers may choose to add a short block to acknowledge the old standards if a student might commonly come across those standards in the wild. However, this block should be demarked as such.
78+
It is **not** the aim of the `about.md` file to provide a complete set of information on the Concept. As an example, imagine a language that has some older features for which experienced programmers (and maybe even the official docs/specs) recommend they should not be used anymore. Providing details on such features would be out of scope for the `about.md` file because they are not relevant to gain fluency. However, maintainers may choose to add a short block to acknowledge the old standards if a student might commonly come across those standards in the wild. However, this block should be marked as such.
7979

8080
The `about.md` file MUST be clearly structured, especially when it contains a lot of information. In the future there will also be support for marking parts as "advanced topics" to point them out to interested students without overloading others.
8181

building/tracks/practice-exercises.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Practice Exercises
22

3-
[Practice Exercises](../../product/practice-exercises.md) are exercises designed to allow students to solve an arbitary problem, with the aim of them making use of the concepts they have learnt so far.
3+
[Practice Exercises](../../product/practice-exercises.md) are exercises designed to allow students to solve an arbitrary problem, with the aim of them making use of the concepts they have learnt so far.
44

55
## Metadata
66

@@ -108,7 +108,7 @@ We place high value on making Exercism's content safe for everyone and so often
108108

109109
- Try to make sure the story is welcoming and can be understood by everyone. If the story contains in-jokes or regional slang, try to think of alternative phrases.
110110
- Try to write examples that are inclusive to everyone. For example, consider using names from other cultures and mixed genders.
111-
- Ask yourself whether you know anyone personally who would take offense by the story. If that's the case, consider changing it to avoid it.
111+
- Ask yourself whether you know anyone personally who would take offence by the story. If that's the case, consider changing it to avoid it.
112112

113113
#### Example
114114

@@ -150,7 +150,7 @@ We place high value on making Exercism's content safe for everyone and so often
150150

151151
- Try to make sure the story is welcoming and can be understood by everyone. If the story contains in-jokes or regional slang, try to think of alternative phrases.
152152
- Try to write examples that are inclusive to everyone. For example, consider using names from other cultures and mixed genders.
153-
- Ask yourself whether you know anyone personally who would take offense by the story. If that's the case, consider changing it to avoid it.
153+
- Ask yourself whether you know anyone personally who would take offence by the story. If that's the case, consider changing it to avoid it.
154154

155155
#### Example
156156

0 commit comments

Comments
 (0)