Fix typo and minor style issues in all READMEs #1356
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Fix `shold` to `should` * Fix minor style issues in `### Common pytest options` * Add blank line after all headers
cmccandless
suggested changes
Feb 27, 2018
config/exercise_readme.go.tmpl
Outdated
| @@ -26,14 +26,15 @@ To run the tests, run the appropriate command below ([why they are different](ht | |||
| - Python 3.3+: `pytest {{ .Spec.SnakeCaseName }}_test.py` | |||
|
|
|||
| 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` | |||
| `python -m pytest {{ .Spec.SnakeCaseName }}_test.py`. | |||
There was a problem hiding this comment.
You don't need a period. python -m pytest {{ .Spec.SnakeCaseName }}_test.py is complete.
config/exercise_readme.go.tmpl
Outdated
| - `-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`. |
There was a problem hiding this comment.
Again, no period needed.
| @@ -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: | |||
cmccandless
approved these changes
Mar 5, 2018
mrcfps
added a commit
to mrcfps/python
that referenced
this pull request
Apr 20, 2018
pig-latin: improve documentation (exercism#1352) add "Running the tests" section to README template (exercism#1271) * add "Running the tests" section to README template * regenerate README files with new template * rewrite Running the tests section for clarity * -switch to a plaintext-readable format -add link explaining py.test vs pytest queen-attack: re-implement according to canonical data 2.1.0 (exercism#1351) * queen-attack: re-implement according to canonical data 2.1.0 * queen-attack: rewrite to pass tests v2.1.0 * queen-attack: remove redundant tests Rm `test_invalid_position_can_attack` since `Queen()` grains: update tests to v1.1.0 (exercism#1357) Fix typo and minor style issues in all READMEs (exercism#1356) * Fix typo and style in README template * Fix `shold` to `should` * Fix minor style issues in `### Common pytest options` * Add blank line after all headers * Regenerate all READMEs * Remove redundant periods in READMEs add `awaiting review` exempt label to stale.yml (exercism#1364) go-counting: adapt tests to canonical data v1.0.0 (exercism#1360) * set correct canonical data version * adapt tests and example solution to canonical data 1.0.0 * use assertSetEqual() consistently sgf-parsing: implement exercise (exercism#1359) * implement sgf-parsing * fix import statement * create entry in config.json * fix __eq__ for Python2 lens-person: forego exercise (exercism#1299) * lens-person: forego exercise `lens-person` is specific to languages with immutable data (i.e. Haskell). This concept does not exist in Python, so the exercise should be foregone. * remove bad comma Implement exercise bank-account (exercism#1260) * Implement exercise bank-account * bank-account: generate README using configlet * bank-account: fix typo and comments pascals-triangle: update tests to canonical-date v1.2.0 (exercism#1164) house: return singleton list for single verse (exercism#1354) * house: return singleton list for single verse RE exercism#1347 ([comment](exercism#1347 (comment))) * house: fix example solution to pass changed tests meetup: remove fail-safe for undefined MeetupDayException (exercism#1345) * meetup: remove fail-safe for undefined MeetupDayException Fixes exercism#1344 * meetup: define MeetupDayException in example solution * meetup: fix example solution to raise correct exception * meetup: fix flake8 violations * meetup: add exception message Curriculum (exercism#1355) * select core exercises and set exercise ordering * add missing obvious topics * make list-ops a core exercise * rational-numbers: increase difficulty * unlocked_by core exercises only (exercism/configlet#61) Ref: exercism/DEPRECATED.v2-feedback#61 (comment) alphametics: mark computationally intensive test as extra-credit (exercism#1358) * alphametics: mark computationally intensive test as extra-credit While this test is canonical, it does not technically add additional coverage. This test serves as a test for efficiency (exercism/problem-specifications#1024 (comment)) of a solution, not completeness. Furthermore, here are the run-times for this exercise from the [latest Travis build]() (at the time of this writing): | Python Version | Run-time (seconds) | | --- | --- | | 2.7 | 3.155 | | 3.3 | 2.461 | | 3.4 | 3.567 | | 3.5 | 7.270 | | 3.6 | 0.774 | Notice that the optimized example solution is only "fast" in 3.6. * alphametics: add to list of exercises allowed to skip tests in CI bank-account: update README using configlet (exercism#1366) go-counting: update README to latest description (exercism#1367) bracket-push: update tests to v1.3.0 (exercism#1369) isbn-verifier: update tests to v2.4.0 (exercism#1373) * Replace test case - "invalid character in isbn" * Add test case with only 9 digits Python "bowling" test issue. (exercism#1372) Fixes /exercism/python/exercism#1371. yacht: implement exercise (exercism#1368) * yacht: implement exercise * yacht: use enumeration of score categories * Use enumeration instead of plain strings to represent categories * Improve func `ns` in example solution crypto-square: Clarify rectangular output requirement in README (exercism#1375) scale-generator: clarify docs. (exercism#1374) * Removed most mentions of terms that were irrelevant ("diminished interval") or undefined ("accidentals"). * Removed irrelevant table * Some light reformatting
cmccandless
pushed a commit
that referenced
this pull request
Apr 20, 2018
* react: re-implement according to canonical data * react: update tests to v1.2.0 * react: correct test method name * react: fix example solution py2-compatibility * `copy()` method to `[:]` * `clear()` method to reassigning an empty list * react: refactor callbacks into pure functions * Merge upstream/master into react-1257 pig-latin: improve documentation (#1352) add "Running the tests" section to README template (#1271) * add "Running the tests" section to README template * regenerate README files with new template * rewrite Running the tests section for clarity * -switch to a plaintext-readable format -add link explaining py.test vs pytest queen-attack: re-implement according to canonical data 2.1.0 (#1351) * queen-attack: re-implement according to canonical data 2.1.0 * queen-attack: rewrite to pass tests v2.1.0 * queen-attack: remove redundant tests Rm `test_invalid_position_can_attack` since `Queen()` grains: update tests to v1.1.0 (#1357) Fix typo and minor style issues in all READMEs (#1356) * Fix typo and style in README template * Fix `shold` to `should` * Fix minor style issues in `### Common pytest options` * Add blank line after all headers * Regenerate all READMEs * Remove redundant periods in READMEs add `awaiting review` exempt label to stale.yml (#1364) go-counting: adapt tests to canonical data v1.0.0 (#1360) * set correct canonical data version * adapt tests and example solution to canonical data 1.0.0 * use assertSetEqual() consistently sgf-parsing: implement exercise (#1359) * implement sgf-parsing * fix import statement * create entry in config.json * fix __eq__ for Python2 lens-person: forego exercise (#1299) * lens-person: forego exercise `lens-person` is specific to languages with immutable data (i.e. Haskell). This concept does not exist in Python, so the exercise should be foregone. * remove bad comma Implement exercise bank-account (#1260) * Implement exercise bank-account * bank-account: generate README using configlet * bank-account: fix typo and comments pascals-triangle: update tests to canonical-date v1.2.0 (#1164) house: return singleton list for single verse (#1354) * house: return singleton list for single verse RE #1347 ([comment](#1347 (comment))) * house: fix example solution to pass changed tests meetup: remove fail-safe for undefined MeetupDayException (#1345) * meetup: remove fail-safe for undefined MeetupDayException Fixes #1344 * meetup: define MeetupDayException in example solution * meetup: fix example solution to raise correct exception * meetup: fix flake8 violations * meetup: add exception message Curriculum (#1355) * select core exercises and set exercise ordering * add missing obvious topics * make list-ops a core exercise * rational-numbers: increase difficulty * unlocked_by core exercises only (exercism/configlet#61) Ref: exercism/DEPRECATED.v2-feedback#61 (comment) alphametics: mark computationally intensive test as extra-credit (#1358) * alphametics: mark computationally intensive test as extra-credit While this test is canonical, it does not technically add additional coverage. This test serves as a test for efficiency (exercism/problem-specifications#1024 (comment)) of a solution, not completeness. Furthermore, here are the run-times for this exercise from the [latest Travis build]() (at the time of this writing): | Python Version | Run-time (seconds) | | --- | --- | | 2.7 | 3.155 | | 3.3 | 2.461 | | 3.4 | 3.567 | | 3.5 | 7.270 | | 3.6 | 0.774 | Notice that the optimized example solution is only "fast" in 3.6. * alphametics: add to list of exercises allowed to skip tests in CI bank-account: update README using configlet (#1366) go-counting: update README to latest description (#1367) bracket-push: update tests to v1.3.0 (#1369) isbn-verifier: update tests to v2.4.0 (#1373) * Replace test case - "invalid character in isbn" * Add test case with only 9 digits Python "bowling" test issue. (#1372) Fixes /exercism/python/#1371. yacht: implement exercise (#1368) * yacht: implement exercise * yacht: use enumeration of score categories * Use enumeration instead of plain strings to represent categories * Improve func `ns` in example solution crypto-square: Clarify rectangular output requirement in README (#1375) scale-generator: clarify docs. (#1374) * Removed most mentions of terms that were irrelevant ("diminished interval") or undefined ("accidentals"). * Removed irrelevant table * Some light reformatting * react: update tests to v2.0.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've fixed minor issues below and then regenerate all READMEs using configlet.
pytestand its options inCommon pytest optionssection.Common pytest optionssection.### Common pytest optionsand## Submitting Incomplete Solutions, which is required in MD022 from the markdownlint project.