Skip to content

Commit

Permalink
Updates the README files for various exercises (#696)
Browse files Browse the repository at this point in the history
* Updates the README files for various exercises

Ran the `update-docs.sh` script to update the README files and apply any
patches that were necessary.

* Updates patch to handle removed section upstream
  • Loading branch information
Zureka authored and ErikSchierboom committed Oct 12, 2018
1 parent 03a4329 commit 63ed0c1
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 15 deletions.
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
diff --git a/exercises/accumulate/README.md b/exercises/accumulate/README.md
index 87f1fd1..12a25d4 100644
index f9679c7..12a25d4 100644
--- a/exercises/accumulate/README.md
+++ b/exercises/accumulate/README.md
@@ -35,7 +35,7 @@ To run the tests, run the command `dotnet test` from within the exercise directo
@@ -33,6 +33,10 @@ This exercise requires you to write an extension method. For more information, s

### Laziness test
To run the tests, run the command `dotnet test` from within the exercise directory.

-Since `accumulate` returns an IEnumerable it's execution can be deferred until `ToList()` it is called on it and this is tested with the `Accumulate_is_lazy` method
+### Laziness test
+
+Since `accumulate` returns an `IEnumerable`, it's execution is deferred until `ToList()` it is called on it, which is tested with the `Accumulate_is_lazy` method
+
## Further information

For more detailed information about the C# track, including how to get help if
4 changes: 2 additions & 2 deletions exercises/change/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ that the sum of the coins' value would equal the correct amount of change.
## For example

- An input of 15 with [1, 5, 10, 25, 100] should return one nickel (5)
and one dime (10) or [0, 1, 1, 0, 0]
and one dime (10) or [5, 10]
- An input of 40 with [1, 5, 10, 25, 100] should return one nickel (5)
and one dime (10) and one quarter (25) or [0, 1, 1, 1, 0]
and one dime (10) and one quarter (25) or [5, 10, 25]

## Edge cases

Expand Down
2 changes: 1 addition & 1 deletion exercises/crypto-square/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ chunks with a single trailing space.
```

Notice that were we to stack these, we could visually decode the
cyphertext back in to the original message:
ciphertext back in to the original message:

```text
"imtgdvs"
Expand Down
4 changes: 2 additions & 2 deletions exercises/dominoes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Make a chain of dominoes.

Compute a way to order a given set of dominoes in such a way that they form a
correct domino chain (the dots on one half of a stone match the dots on the
neighbouring half of an adjacent stone) and that dots on the halfs of the stones
which don't have a neighbour (the first and last stone) match each other.
neighbouring half of an adjacent stone) and that dots on the halves of the
stones which don't have a neighbour (the first and last stone) match each other.

For example given the stones `[2|1]`, `[2|3]` and `[1|3]` you should compute something
like `[1|2] [2|3] [3|1]` or `[3|2] [2|1] [1|3]` or `[1|3] [3|2] [2|1]` etc, where the first and last numbers are the same.
Expand Down
3 changes: 1 addition & 2 deletions exercises/rest-api/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# REST API
# Rest Api

Implement a RESTful API for tracking IOUs.

Expand Down Expand Up @@ -38,7 +38,6 @@ Your task is to implement a simple [RESTful API](https://en.wikipedia.org/wiki/R
- Example RESTful APIs
- [GitHub](https://developer.github.com/v3/)
- [Reddit](https://www.reddit.com/dev/api/)

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.
Expand Down
2 changes: 2 additions & 0 deletions exercises/saddle-points/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ A matrix may have zero or more saddle points.
Your code should be able to provide the (possibly empty) list of all the
saddle points for any given matrix.

The matrix can have a different number of rows and columns (Non square).

Note that you may find other definitions of matrix saddle points online,
but the tests for this exercise follow the above unambiguous definition.

Expand Down
4 changes: 2 additions & 2 deletions exercises/simple-cipher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ for A, and so with the others."

Ciphers are very straight-forward algorithms that allow us to render
text less readable while still allowing easy deciphering. They are
vulnerable to many forms of cryptoanalysis, but we are lucky that
generally our little sisters are not cryptoanalysts.
vulnerable to many forms of cryptanalysis, but we are lucky that
generally our little sisters are not cryptanalysts.

The Caesar Cipher was used for some messages from Julius Caesar that
were sent afield. Now Caesar knew that the cipher wasn't very good, but
Expand Down
2 changes: 1 addition & 1 deletion exercises/two-fer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ you're having trouble, please visit the exercism.io [C# language page](http://ex

## Source

[https://en.wikipedia.org/wiki/Two-fer](https://en.wikipedia.org/wiki/Two-fer)
[https://github.com/exercism/problem-specifications/issues/757](https://github.com/exercism/problem-specifications/issues/757)

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

0 comments on commit 63ed0c1

Please sign in to comment.