Skip to content

Commit cf4f50f

Browse files
author
Nathan Parsons
authored
Update and reformat all READMEs (exercism#950)
* Move 'Submitting Exercises' to heading level 2 * Regenerate READMEs using configlet * diffie-hellman: add hints.md and regenerate README * collatz-conjecture: add hints.md and regenerate README * simple-cipher: suggest returning a ValueError * two-fer: Remove Test-Driven Development section
1 parent 705a4d3 commit cf4f50f

98 files changed

Lines changed: 367 additions & 452 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/EXERCISE_README_INSERT.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
### Submitting Exercises
1+
## Submitting Exercises
22

33
Note that, when trying to submit an exercise, make sure the solution is in the `exercism/python/<exerciseName>` directory.
44

55
For example, if you're submitting `bob.py` for the Bob exercise, the submit command would be something like `exercism submit <path_to_exercism_dir>/python/bob/bob.py`.
66

7-
87
For more detailed information about running tests, code style and linting,
98
please see the [help page](http://exercism.io/languages/python).

exercises/accumulate/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,12 @@ Keep your hands off that collect/map/fmap/whatchamacallit functionality
2525
provided by your standard library!
2626
Solve this one yourself using other basic tools instead.
2727

28-
Lisp specific: it's perfectly fine to use `MAPCAR` or the equivalent,
29-
as this is idiomatic Lisp, not a library function.
30-
31-
### Submitting Exercises
28+
## Submitting Exercises
3229

3330
Note that, when trying to submit an exercise, make sure the solution is in the `exercism/python/<exerciseName>` directory.
3431

3532
For example, if you're submitting `bob.py` for the Bob exercise, the submit command would be something like `exercism submit <path_to_exercism_dir>/python/bob/bob.py`.
3633

37-
3834
For more detailed information about running tests, code style and linting,
3935
please see the [help page](http://exercism.io/languages/python).
4036

exercises/acronym/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,12 @@ Techies love their TLA (Three Letter Acronyms)!
77
Help generate some jargon by writing a program that converts a long name
88
like Portable Network Graphics to its acronym (PNG).
99

10-
11-
### Submitting Exercises
10+
## Submitting Exercises
1211

1312
Note that, when trying to submit an exercise, make sure the solution is in the `exercism/python/<exerciseName>` directory.
1413

1514
For example, if you're submitting `bob.py` for the Bob exercise, the submit command would be something like `exercism submit <path_to_exercism_dir>/python/bob/bob.py`.
1615

17-
1816
For more detailed information about running tests, code style and linting,
1917
please see the [help page](http://exercism.io/languages/python).
2018

exercises/all-your-base/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Implement general base conversion. Given a number in base **a**,
66
represented as a sequence of digits, convert it to base **b**.
77

88
## Note
9+
910
- Try to implement the conversion yourself.
1011
Do not use something else to perform the conversion for you.
1112

@@ -28,16 +29,14 @@ The number 1120, *in base 3*, means:
2829

2930
I think you got the idea!
3031

31-
3232
*Yes. Those three numbers above are exactly the same. Congratulations!*
3333

34-
### Submitting Exercises
34+
## Submitting Exercises
3535

3636
Note that, when trying to submit an exercise, make sure the solution is in the `exercism/python/<exerciseName>` directory.
3737

3838
For example, if you're submitting `bob.py` for the Bob exercise, the submit command would be something like `exercism submit <path_to_exercism_dir>/python/bob/bob.py`.
3939

40-
4140
For more detailed information about running tests, code style and linting,
4241
please see the [help page](http://exercism.io/languages/python).
4342

exercises/allergies/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,12 @@ allergens that score 256, 512, 1024, etc.). Your program should
2929
ignore those components of the score. For example, if the allergy
3030
score is 257, your program should only report the eggs (1) allergy.
3131

32-
33-
### Submitting Exercises
32+
## Submitting Exercises
3433

3534
Note that, when trying to submit an exercise, make sure the solution is in the `exercism/python/<exerciseName>` directory.
3635

3736
For example, if you're submitting `bob.py` for the Bob exercise, the submit command would be something like `exercism submit <path_to_exercism_dir>/python/bob/bob.py`.
3837

39-
4038
For more detailed information about running tests, code style and linting,
4139
please see the [help page](http://exercism.io/languages/python).
4240

exercises/alphametics/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ letters in words are replaced with numbers.
77

88
For example `SEND + MORE = MONEY`:
99

10-
```
10+
```text
1111
S E N D
1212
M O R E +
1313
-----------
@@ -16,7 +16,7 @@ M O N E Y
1616

1717
Replacing these with valid numbers gives:
1818

19-
```
19+
```text
2020
9 5 6 7
2121
1 0 8 5 +
2222
-----------
@@ -31,13 +31,12 @@ a multi-digit number must not be zero.
3131

3232
Write a function to solve alphametics puzzles.
3333

34-
### Submitting Exercises
34+
## Submitting Exercises
3535

3636
Note that, when trying to submit an exercise, make sure the solution is in the `exercism/python/<exerciseName>` directory.
3737

3838
For example, if you're submitting `bob.py` for the Bob exercise, the submit command would be something like `exercism submit <path_to_exercism_dir>/python/bob/bob.py`.
3939

40-
4140
For more detailed information about running tests, code style and linting,
4241
please see the [help page](http://exercism.io/languages/python).
4342

exercises/anagram/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,12 @@ Given `"listen"` and a list of candidates like `"enlists" "google"
66
"inlets" "banana"` the program should return a list containing
77
`"inlets"`.
88

9-
### Submitting Exercises
9+
## Submitting Exercises
1010

1111
Note that, when trying to submit an exercise, make sure the solution is in the `exercism/python/<exerciseName>` directory.
1212

1313
For example, if you're submitting `bob.py` for the Bob exercise, the submit command would be something like `exercism submit <path_to_exercism_dir>/python/bob/bob.py`.
1414

15-
1615
For more detailed information about running tests, code style and linting,
1716
please see the [help page](http://exercism.io/languages/python).
1817

exercises/atbash-cipher/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ letter, the second with the second-last, and so on.
99

1010
An Atbash cipher for the Latin alphabet would be as follows:
1111

12-
```plain
12+
```text
1313
Plain: abcdefghijklmnopqrstuvwxyz
1414
Cipher: zyxwvutsrqponmlkjihgfedcba
1515
```
@@ -23,17 +23,17 @@ being 5 letters, and punctuation is excluded. This is to make it harder to guess
2323
things based on word boundaries.
2424

2525
## Examples
26+
2627
- Encoding `test` gives `gvhg`
2728
- Decoding `gvhg` gives `test`
2829
- Decoding `gsvjf rxpyi ldmul cqfnk hlevi gsvoz abwlt` gives `thequickbrownfoxjumpsoverthelazydog`
2930

30-
### Submitting Exercises
31+
## Submitting Exercises
3132

3233
Note that, when trying to submit an exercise, make sure the solution is in the `exercism/python/<exerciseName>` directory.
3334

3435
For example, if you're submitting `bob.py` for the Bob exercise, the submit command would be something like `exercism submit <path_to_exercism_dir>/python/bob/bob.py`.
3536

36-
3737
For more detailed information about running tests, code style and linting,
3838
please see the [help page](http://exercism.io/languages/python).
3939

exercises/beer-song/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Produce the lyrics to that beloved classic, that field-trip favorite: 99 Bottles
44

55
Note that not all verses are identical.
66

7-
```plain
7+
```text
88
99 bottles of beer on the wall, 99 bottles of beer.
99
Take one down and pass it around, 98 bottles of beer on the wall.
1010
@@ -320,13 +320,12 @@ are some additional things you could try:
320320
Then please share your thoughts in a comment on the submission. Did this
321321
experiment make the code better? Worse? Did you learn anything from it?
322322

323-
### Submitting Exercises
323+
## Submitting Exercises
324324

325325
Note that, when trying to submit an exercise, make sure the solution is in the `exercism/python/<exerciseName>` directory.
326326

327327
For example, if you're submitting `bob.py` for the Bob exercise, the submit command would be something like `exercism submit <path_to_exercism_dir>/python/bob/bob.py`.
328328

329-
330329
For more detailed information about running tests, code style and linting,
331330
please see the [help page](http://exercism.io/languages/python).
332331

exercises/binary-search/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,12 @@ A binary search halves the number of items to check with each iteration,
3434
so locating an item (or determining its absence) takes logarithmic time.
3535
A binary search is a dichotomic divide and conquer search algorithm.
3636

37-
### Submitting Exercises
37+
## Submitting Exercises
3838

3939
Note that, when trying to submit an exercise, make sure the solution is in the `exercism/python/<exerciseName>` directory.
4040

4141
For example, if you're submitting `bob.py` for the Bob exercise, the submit command would be something like `exercism submit <path_to_exercism_dir>/python/bob/bob.py`.
4242

43-
4443
For more detailed information about running tests, code style and linting,
4544
please see the [help page](http://exercism.io/languages/python).
4645

0 commit comments

Comments
 (0)