Skip to content

Fix typo and minor style issues in all READMEs #1356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions config/exercise_readme.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thanks!


```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -28,10 +28,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest {{ .Spec.SnakeCaseName }}_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -49,4 +50,5 @@ please see the [help page](http://exercism.io/languages/python).
{{ . }}
{{ end }}
## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/accumulate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -49,10 +49,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest accumulate_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -70,4 +71,5 @@ please see the [help page](http://exercism.io/languages/python).
Conversation with James Edward Gray II [https://twitter.com/jeg2](https://twitter.com/jeg2)

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/acronym/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -31,10 +31,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest acronym_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -52,4 +53,5 @@ please see the [help page](http://exercism.io/languages/python).
Julien Vanier [https://github.com/monkbroc](https://github.com/monkbroc)

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/all-your-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -55,10 +55,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest all_your_base_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -72,4 +73,5 @@ For more detailed information about running tests, code style and linting,
please see the [help page](http://exercism.io/languages/python).

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/allergies/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -53,10 +53,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest allergies_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -74,4 +75,5 @@ please see the [help page](http://exercism.io/languages/python).
Jumpstart Lab Warm-up [http://jumpstartlab.com](http://jumpstartlab.com)

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/alphametics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -55,10 +55,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest alphametics_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -72,4 +73,5 @@ For more detailed information about running tests, code style and linting,
please see the [help page](http://exercism.io/languages/python).

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/anagram/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -30,10 +30,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest anagram_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -51,4 +52,5 @@ please see the [help page](http://exercism.io/languages/python).
Inspired by the Extreme Startup game [https://github.com/rchatley/extreme_startup](https://github.com/rchatley/extreme_startup)

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/armstrong-numbers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -35,10 +35,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest armstrong_numbers_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -56,4 +57,5 @@ please see the [help page](http://exercism.io/languages/python).
Wikipedia [https://en.wikipedia.org/wiki/Narcissistic_number](https://en.wikipedia.org/wiki/Narcissistic_number)

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/atbash-cipher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -52,10 +52,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest atbash_cipher_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -73,4 +74,5 @@ please see the [help page](http://exercism.io/languages/python).
Wikipedia [http://en.wikipedia.org/wiki/Atbash](http://en.wikipedia.org/wiki/Atbash)

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/beer-song/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -344,10 +344,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest beer_song_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -365,4 +366,5 @@ please see the [help page](http://exercism.io/languages/python).
Learn to Program by Chris Pine [http://pine.fm/LearnToProgram/?Chapter=06](http://pine.fm/LearnToProgram/?Chapter=06)

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/binary-search-tree/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -77,10 +77,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest binary_search_tree_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -98,4 +99,5 @@ please see the [help page](http://exercism.io/languages/python).
Josh Cheek [https://twitter.com/josh_cheek](https://twitter.com/josh_cheek)

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
12 changes: 7 additions & 5 deletions exercises/binary-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ every exercise will require you to raise an exception, but for those that do, th
a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
`raise Exception`, you shold write:
`raise Exception`, you should write:

```python
raise Exception("Meaningful message indicating the source of the error")
Expand All @@ -58,10 +58,11 @@ To run the tests, run the appropriate command below ([why they are different](ht
Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version):
`python -m pytest binary_search_test.py`

### Common pytest options
- -v : enable verbose output
- -x : stop running tests on first failure
- --ff : run failures from previous test before running other test cases
### Common `pytest` options

- `-v` : enable verbose output
- `-x` : stop running tests on first failure
- `--ff` : run failures from previous test before running other test cases

For other options, see `python -m pytest -h`

Expand All @@ -79,4 +80,5 @@ please see the [help page](http://exercism.io/languages/python).
Wikipedia [http://en.wikipedia.org/wiki/Binary_search_algorithm](http://en.wikipedia.org/wiki/Binary_search_algorithm)

## Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.
Loading