Skip to content

Commit 3229cc1

Browse files
ErikSchierboomErikSchierboom
committed
docs: Convert function word in README's to method
1 parent a5da34b commit 3229cc1

File tree

11 files changed

+287
-22
lines changed

11 files changed

+287
-22
lines changed

‎config/patches/0001-function_to_method.patch

Lines changed: 254 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,254 @@
1+
diff --git a/exercises/accumulate/README.md b/exercises/accumulate/README.md
2+
index 81cf1e4..c9d0cb8 100644
3+
--- a/exercises/accumulate/README.md
4+
+++ b/exercises/accumulate/README.md
5+
@@ -17,7 +17,7 @@ Your code should be able to produce the collection of squares:
6+
7+
- 1, 4, 9, 16, 25
8+
9+
-Check out the test suite to see the expected function signature.
10+
+Check out the test suite to see the expected method signature.
11+
12+
## Restrictions
13+
14+
@@ -25,7 +25,8 @@ Keep your hands off that collect/map/fmap/whatchamacallit functionality
15+
provided by your standard library!
16+
Solve this one yourself using other basic tools instead.
17+
18+
-## Hints
19+
+## Hints
20+
+
21+
This exercise requires you to write an extension method. For more information, see [this page](https://msdn.microsoft.com/en-us//library/bb383977.aspx).
22+
23+
## Running the tests
24+
@@ -42,4 +43,5 @@ you're having trouble, please visit the exercism.io [C# language page](http://ex
25+
Conversation with James Edward Gray II [https://twitter.com/jeg2](https://twitter.com/jeg2)
26+
27+
## Submitting Incomplete Solutions
28+
+
29+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
30+
diff --git a/exercises/alphametics/README.md b/exercises/alphametics/README.md
31+
index 2dc28f6..e2497b3 100644
32+
--- a/exercises/alphametics/README.md
33+
+++ b/exercises/alphametics/README.md
34+
@@ -1,6 +1,6 @@
35+
# Alphametics
36+
37+
-Write a function to solve alphametics puzzles.
38+
+Write a method to solve alphametics puzzles.
39+
40+
[Alphametics](https://en.wikipedia.org/wiki/Alphametics) is a puzzle where
41+
letters in words are replaced with numbers.
42+
@@ -29,15 +29,15 @@ words, translated into numbers, then make a valid sum.
43+
Each letter must represent a different digit, and the leading digit of
44+
a multi-digit number must not be zero.
45+
46+
-Write a function to solve alphametics puzzles.
47+
+Write a method to solve alphametics puzzles.
48+
49+
## Hints
50+
+
51+
- To parse the text, you could try to use the [Sprache](https://github.com/sprache/Sprache/blob/develop/README.md) library. You can also find a good tutorial [here](https://www.thomaslevesque.com/2017/02/23/easy-text-parsing-in-c-with-sprache/).
52+
- You can solve this exercise with a brute force algorithm, but this will possibly have a poor runtime performance.
53+
-Try to find a more sophisticated solution.
54+
+ Try to find a more sophisticated solution.
55+
- Hint: You could try the column-wise addition algorithm that is usually taught in school.
56+
57+
-
58+
## Running the tests
59+
60+
To run the tests, run the command `dotnet test` from within the exercise directory.
61+
@@ -48,4 +48,5 @@ For more detailed information about the C# track, including how to get help if
62+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
63+
64+
## Submitting Incomplete Solutions
65+
+
66+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
67+
diff --git a/exercises/flatten-array/README.md b/exercises/flatten-array/README.md
68+
index e8e0b20..c075be1 100644
69+
--- a/exercises/flatten-array/README.md
70+
+++ b/exercises/flatten-array/README.md
71+
@@ -2,7 +2,7 @@
72+
73+
Take a nested list and return a single flattened list with all values except nil/null.
74+
75+
-The challenge is to write a function that accepts an arbitrarily-deep nested list-like structure and returns a flattened structure without any nil/null values.
76+
+The challenge is to write a method that accepts an arbitrarily-deep nested list-like structure and returns a flattened structure without any nil/null values.
77+
78+
For Example
79+
80+
@@ -24,4 +24,5 @@ you're having trouble, please visit the exercism.io [C# language page](http://ex
81+
Interview Question [https://reference.wolfram.com/language/ref/Flatten.html](https://reference.wolfram.com/language/ref/Flatten.html)
82+
83+
## Submitting Incomplete Solutions
84+
+
85+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
86+
diff --git a/exercises/go-counting/README.md b/exercises/go-counting/README.md
87+
index a2b43da..95d6253 100644
88+
--- a/exercises/go-counting/README.md
89+
+++ b/exercises/go-counting/README.md
90+
@@ -7,16 +7,16 @@ are gained by completely encircling empty intersections with your
91+
stones. The encircled intersections of a player are known as its
92+
territory.
93+
94+
-Write a function that determines the territory of each player. You may
95+
+Write a method that determines the territory of each player. You may
96+
assume that any stones that have been stranded in enemy territory have
97+
already been taken off the board.
98+
99+
-Write a function that determines the territory which includes a specified coordinate.
100+
+Write a method that determines the territory which includes a specified coordinate.
101+
102+
Multiple empty intersections may be encircled at once and for encircling
103+
only horizontal and vertical neighbours count. In the following diagram
104+
the stones which matter are marked "O" and the stones that don't are
105+
-marked "I" (ignored). Empty spaces represent empty intersections.
106+
+marked "I" (ignored). Empty spaces represent empty intersections.
107+
108+
```text
109+
+----+
110+
@@ -45,4 +45,5 @@ For more detailed information about the C# track, including how to get help if
111+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
112+
113+
## Submitting Incomplete Solutions
114+
+
115+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
116+
diff --git a/exercises/hello-world/README.md b/exercises/hello-world/README.md
117+
index 7e05640..794cb60 100644
118+
--- a/exercises/hello-world/README.md
119+
+++ b/exercises/hello-world/README.md
120+
@@ -8,7 +8,7 @@ or environment.
121+
122+
The objectives are simple:
123+
124+
-- Write a function that returns the string "Hello, World!".
125+
+- Write a method that returns the string "Hello, World!".
126+
- Run the test suite and make sure that it succeeds.
127+
- Submit your solution and check it at the website.
128+
129+
@@ -25,7 +25,8 @@ you're having trouble, please visit the exercism.io [C# language page](http://ex
130+
131+
## Source
132+
133+
-This is an exercise to introduce users to using Exercism [http://en.wikipedia.org/wiki/%22Hello,_world!%22_program](http://en.wikipedia.org/wiki/%22Hello,_world!%22_program)
134+
+This is an exercise to introduce users to using Exercism [http://en.wikipedia.org/wiki/%22Hello,\_world!%22_program](http://en.wikipedia.org/wiki/%22Hello,_world!%22_program)
135+
136+
## Submitting Incomplete Solutions
137+
+
138+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
139+
diff --git a/exercises/parallel-letter-frequency/README.md b/exercises/parallel-letter-frequency/README.md
140+
index 45ffc25..98821ea 100644
141+
--- a/exercises/parallel-letter-frequency/README.md
142+
+++ b/exercises/parallel-letter-frequency/README.md
143+
@@ -4,7 +4,7 @@ Count the frequency of letters in texts using parallel computation.
144+
145+
Parallelism is about doing things in parallel that can also be done
146+
sequentially. A common example is counting the frequency of letters.
147+
-Create a function that returns the total frequency of each letter in a
148+
+Create a method that returns the total frequency of each letter in a
149+
list of texts and that employs parallelism.
150+
151+
## Running the tests
152+
@@ -17,4 +17,5 @@ For more detailed information about the C# track, including how to get help if
153+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
154+
155+
## Submitting Incomplete Solutions
156+
+
157+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
158+
diff --git a/exercises/roman-numerals/README.md b/exercises/roman-numerals/README.md
159+
index ff2ca53..ae048ee 100644
160+
--- a/exercises/roman-numerals/README.md
161+
+++ b/exercises/roman-numerals/README.md
162+
@@ -1,6 +1,6 @@
163+
# Roman Numerals
164+
165+
-Write a function to convert from normal numbers to Roman Numerals.
166+
+Write a method to convert from normal numbers to Roman Numerals.
167+
168+
The Romans were a clever bunch. They conquered most of Europe and ruled
169+
it for hundreds of years. They invented concrete and straight roads and
170+
@@ -43,8 +43,8 @@ In Roman numerals 1990 is MCMXC:
171+
See also: http://www.novaroma.org/via_romana/numbers.html
172+
173+
## Hints
174+
-This exercise requires you to write an extension method. For more information, see [this page](https://msdn.microsoft.com/en-us//library/bb383977.aspx).
175+
176+
+This exercise requires you to write an extension method. For more information, see [this page](https://msdn.microsoft.com/en-us//library/bb383977.aspx).
177+
178+
## Running the tests
179+
180+
@@ -60,4 +60,5 @@ you're having trouble, please visit the exercism.io [C# language page](http://ex
181+
The Roman Numeral Kata [http://codingdojo.org/cgi-bin/index.pl?KataRomanNumerals](http://codingdojo.org/cgi-bin/index.pl?KataRomanNumerals)
182+
183+
## Submitting Incomplete Solutions
184+
+
185+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
186+
diff --git a/exercises/secret-handshake/README.md b/exercises/secret-handshake/README.md
187+
index c9e721a..bb6a409 100644
188+
--- a/exercises/secret-handshake/README.md
189+
+++ b/exercises/secret-handshake/README.md
190+
@@ -20,10 +20,10 @@ Given a decimal number, convert it to the appropriate sequence of events for a s
191+
192+
Here's a couple of examples:
193+
194+
-Given the input 3, the function would return the array
195+
+Given the input 3, the method would return the array
196+
["wink", "double blink"] because 3 is 11 in binary.
197+
198+
-Given the input 19, the function would return the array
199+
+Given the input 19, the method would return the array
200+
["double blink", "wink"] because 19 is 10011 in binary.
201+
Notice that the addition of 16 (10000 in binary)
202+
has caused the array to be reversed.
203+
@@ -42,4 +42,5 @@ you're having trouble, please visit the exercism.io [C# language page](http://ex
204+
Bert, in Mary Poppins [http://www.imdb.com/title/tt0058331/quotes/qt0437047](http://www.imdb.com/title/tt0058331/quotes/qt0437047)
205+
206+
## Submitting Incomplete Solutions
207+
+
208+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
209+
diff --git a/exercises/simple-cipher/README.md b/exercises/simple-cipher/README.md
210+
index 65c9b27..e66502b 100644
211+
--- a/exercises/simple-cipher/README.md
212+
+++ b/exercises/simple-cipher/README.md
213+
@@ -29,9 +29,9 @@ This image is a great example of the Caesar Cipher:
214+
215+
For example:
216+
217+
-Giving "iamapandabear" as input to the encode function returns the cipher "ldpdsdqgdehdu". Obscure enough to keep our message secret in transit.
218+
+Giving "iamapandabear" as input to the encode method returns the cipher "ldpdsdqgdehdu". Obscure enough to keep our message secret in transit.
219+
220+
-When "ldpdsdqgdehdu" is put into the decode function it would return
221+
+When "ldpdsdqgdehdu" is put into the decode method it would return
222+
the original "iamapandabear" letting your friend read your original
223+
message.
224+
225+
@@ -95,4 +95,5 @@ you're having trouble, please visit the exercism.io [C# language page](http://ex
226+
Substitution Cipher at Wikipedia [http://en.wikipedia.org/wiki/Substitution_cipher](http://en.wikipedia.org/wiki/Substitution_cipher)
227+
228+
## Submitting Incomplete Solutions
229+
+
230+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
231+
diff --git a/exercises/word-search/README.md b/exercises/word-search/README.md
232+
index 2bea144..715df22 100644
233+
--- a/exercises/word-search/README.md
234+
+++ b/exercises/word-search/README.md
235+
@@ -28,10 +28,10 @@ letter of each word.
236+
237+
## HINTS
238+
239+
-One of the uses of Tuples is returning multiple values from a function. In this exercise, write
240+
-a function that returns a Tuple (the x- and y- part of a coordinate).
241+
+One of the uses of Tuples is returning multiple values from a function. In this exercise, write
242+
+a method that returns a Tuple (the x- and y- part of a coordinate).
243+
244+
-For more information on Tuples, see [this link](https://msdn.microsoft.com/en-us/library/system.tuple(v=vs.110).aspx).
245+
+For more information on Tuples, see [this link](<https://msdn.microsoft.com/en-us/library/system.tuple(v=vs.110).aspx>).
246+
247+
## Running the tests
248+
249+
@@ -43,4 +43,5 @@ For more detailed information about the C# track, including how to get help if
250+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
251+
252+
## Submitting Incomplete Solutions
253+
+
254+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.

‎exercises/accumulate/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,16 @@ Your code should be able to produce the collection of squares:
1717

1818
- 1, 4, 9, 16, 25
1919

20-
Check out the test suite to see the expected function signature.
20+
Check out the test suite to see the expected method signature.
2121

2222
## Restrictions
2323

2424
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-
## Hints
28+
## Hints
29+
2930
This exercise requires you to write an extension method. For more information, see [this page](https://msdn.microsoft.com/en-us//library/bb383977.aspx).
3031

3132
## Running the tests
@@ -42,4 +43,5 @@ you're having trouble, please visit the exercism.io [C# language page](http://ex
4243
Conversation with James Edward Gray II [https://twitter.com/jeg2](https://twitter.com/jeg2)
4344

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

‎exercises/alphametics/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Alphametics
22

3-
Write a function to solve alphametics puzzles.
3+
Write a method to solve alphametics puzzles.
44

55
[Alphametics](https://en.wikipedia.org/wiki/Alphametics) is a puzzle where
66
letters in words are replaced with numbers.
@@ -29,15 +29,15 @@ words, translated into numbers, then make a valid sum.
2929
Each letter must represent a different digit, and the leading digit of
3030
a multi-digit number must not be zero.
3131

32-
Write a function to solve alphametics puzzles.
32+
Write a method to solve alphametics puzzles.
3333

3434
## Hints
35+
3536
- To parse the text, you could try to use the [Sprache](https://github.com/sprache/Sprache/blob/develop/README.md) library. You can also find a good tutorial [here](https://www.thomaslevesque.com/2017/02/23/easy-text-parsing-in-c-with-sprache/).
3637
- You can solve this exercise with a brute force algorithm, but this will possibly have a poor runtime performance.
37-
Try to find a more sophisticated solution.
38+
Try to find a more sophisticated solution.
3839
- Hint: You could try the column-wise addition algorithm that is usually taught in school.
3940

40-
4141
## Running the tests
4242

4343
To run the tests, run the command `dotnet test` from within the exercise directory.
@@ -48,4 +48,5 @@ For more detailed information about the C# track, including how to get help if
4848
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
4949

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

‎exercises/flatten-array/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Take a nested list and return a single flattened list with all values except nil/null.
44

5-
The challenge is to write a function that accepts an arbitrarily-deep nested list-like structure and returns a flattened structure without any nil/null values.
5+
The challenge is to write a method that accepts an arbitrarily-deep nested list-like structure and returns a flattened structure without any nil/null values.
66

77
For Example
88

@@ -24,4 +24,5 @@ you're having trouble, please visit the exercism.io [C# language page](http://ex
2424
Interview Question [https://reference.wolfram.com/language/ref/Flatten.html](https://reference.wolfram.com/language/ref/Flatten.html)
2525

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

‎exercises/go-counting/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ are gained by completely encircling empty intersections with your
77
stones. The encircled intersections of a player are known as its
88
territory.
99

10-
Write a function that determines the territory of each player. You may
10+
Write a method that determines the territory of each player. You may
1111
assume that any stones that have been stranded in enemy territory have
1212
already been taken off the board.
1313

14-
Write a function that determines the territory which includes a specified coordinate.
14+
Write a method that determines the territory which includes a specified coordinate.
1515

1616
Multiple empty intersections may be encircled at once and for encircling
1717
only horizontal and vertical neighbours count. In the following diagram
1818
the stones which matter are marked "O" and the stones that don't are
19-
marked "I" (ignored). Empty spaces represent empty intersections.
19+
marked "I" (ignored). Empty spaces represent empty intersections.
2020

2121
```text
2222
+----+
@@ -45,4 +45,5 @@ For more detailed information about the C# track, including how to get help if
4545
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
4646

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

‎exercises/hello-world/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ or environment.
88

99
The objectives are simple:
1010

11-
- Write a function that returns the string "Hello, World!".
11+
- Write a method that returns the string "Hello, World!".
1212
- Run the test suite and make sure that it succeeds.
1313
- Submit your solution and check it at the website.
1414

@@ -25,7 +25,8 @@ you're having trouble, please visit the exercism.io [C# language page](http://ex
2525

2626
## Source
2727

28-
This is an exercise to introduce users to using Exercism [http://en.wikipedia.org/wiki/%22Hello,_world!%22_program](http://en.wikipedia.org/wiki/%22Hello,_world!%22_program)
28+
This is an exercise to introduce users to using Exercism [http://en.wikipedia.org/wiki/%22Hello,\_world!%22_program](http://en.wikipedia.org/wiki/%22Hello,_world!%22_program)
2929

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

‎exercises/parallel-letter-frequency/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Count the frequency of letters in texts using parallel computation.
44

55
Parallelism is about doing things in parallel that can also be done
66
sequentially. A common example is counting the frequency of letters.
7-
Create a function that returns the total frequency of each letter in a
7+
Create a method that returns the total frequency of each letter in a
88
list of texts and that employs parallelism.
99

1010
## Running the tests
@@ -17,4 +17,5 @@ For more detailed information about the C# track, including how to get help if
1717
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
1818

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

0 commit comments

Comments
 (0)