Skip to content

Commit ca9bd6f

Browse files
Convert backtick (`) admonition fences to tildes (~) (#3509)
* Convert backtick (`) admonition fences to tildes (~). * Updated Grains Test file to Fix CI [no important files changed] --------- Co-authored-by: BethanyG <[email protected]>
1 parent e1c66c9 commit ca9bd6f

File tree

26 files changed

+64
-64
lines changed

26 files changed

+64
-64
lines changed

concepts/generators/about.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ When `yield` is evaluated, it pauses the execution of the enclosing function and
9494

9595
The function then _stays in scope_, and when `__next__()` is called, execution resumes until `yield` is encountered again.
9696

97-
```exercism/note
97+
~~~~exercism/note
9898
Using `yield` expressions is prohibited outside of functions.
99-
```
99+
~~~~
100100

101101
```python
102102
>>> def infinite_sequence():

exercises/concept/plane-tickets/.docs/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ When `yield` is evaluated, it pauses the execution of the enclosing function and
9494

9595
The function then _stays in scope_, and when `__next__()` is called, execution resumes until `yield` is encountered again.
9696

97-
```exercism/note
97+
~~~~exercism/note
9898
Using `yield` expressions is prohibited outside of functions.
99-
```
99+
~~~~
100100

101101
```python
102102
>>> def infinite_sequence():

exercises/practice/binary-search/.docs/instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Your task is to implement a binary search algorithm.
55
A binary search algorithm finds an item in a list by repeatedly splitting it in half, only keeping the half which contains the item we're looking for.
66
It allows us to quickly narrow down the possible locations of our item until we find it, or until we've eliminated all possible locations.
77

8-
```exercism/caution
8+
~~~~exercism/caution
99
Binary search only works when a list has been sorted.
10-
```
10+
~~~~
1111

1212
The algorithm looks like this:
1313

exercises/practice/bob/.approaches/answer-list/content.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ Python doesn't _enforce_ having real constant values,
2222
but the `ANSWERS` list is defined with all uppercase letters, which is the naming convention for a Python [constant][const].
2323
It indicates that the value is not intended to be changed.
2424

25-
```exercism/note
25+
~~~~exercism/note
2626
`ANSWERS` could prevent item reassignment by being defined as a [tuple](https://realpython.com/python-lists-tuples/#python-tuples) instead of a list.
2727
The items in a tuple cannot be changed, and the performance between a tuple and a list here is equivalent.
2828
The entire `ANSWERS` tuple could still be reassigned to another tuple,
2929
so uppercase letters would still be used to indicate that the `ANSWERS` tuple should not be changed.
30-
```
30+
~~~~
3131

3232
The [`rstrip`][rstrip] method is applied to the input to eliminate any whitespace at the end of the input.
3333
If the input has no characters left, it uses the [falsiness][falsiness] of an empty string with the [`not`][not] operator to return the response for saying nothing.
@@ -37,11 +37,11 @@ A [ternary operator][ternary] is used for determining the score for a shout and
3737

3838
The [`isupper`][isupper] method is used to test that there is at least one cased character and that all cased characters are uppercase.
3939

40-
```exercism/note
40+
~~~~exercism/note
4141
A cased character is one which differs between lowercase and uppercase.
4242
For example, `?` and `3` are not cased characters, as they do not change between lowercase and uppercase.
4343
`a` and `z` are cased characters, since their lowercase form changes to `A` and ` Z` when uppercase.
44-
```
44+
~~~~
4545

4646
If `isupper` is `True`, then `is_shout` is given the value of `2`; otherwise, it is given the value of `0`.
4747

exercises/practice/bob/.approaches/if-statements-nested/content.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,23 @@ def response(hey_bob):
2020
In this approach you have a series of `if` statements using the calculated variables to evaluate the conditions, some of which are nested.
2121
As soon as a `True` condition is found, the correct response is returned.
2222

23-
```exercism/note
23+
~~~~exercism/note
2424
Note that there are no `elif` or `else` statements.
2525
If an `if` statement can return, then an `elif` or `else` is not needed.
2626
Execution will either return or will continue to the next statement anyway.
27-
```
27+
~~~~
2828

2929
The [`rstrip`][rstrip] method is applied to the input to eliminate any whitespace at the end of the input.
3030
If the input has no characters left, it uses the [falsiness][falsiness] of an empty string with the [`not`][not] operator to return the response for saying nothing.
3131
Since it doesn't matter if there is leading whitespace, the `rstrip` function is used instead of [`strip`][strip].
3232

3333
The [`isupper`][isupper] method is used to test that there is at least one cased character and that all cased characters are uppercase.
3434

35-
```exercism/note
35+
~~~~exercism/note
3636
A cased character is one which differs between lowercase and uppercase.
3737
For example, `?` and `3` are not cased characters, as they do not change between lowercase and uppercase.
3838
`a` and `z` are cased characters, since their lowercase form changes to `A` and ` Z` when uppercase.
39-
```
39+
~~~~
4040

4141
The [`endswith`][endswith] method is used to determine if the input ends with a question mark.
4242

exercises/practice/bob/.approaches/if-statements/content.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,23 @@ def response(hey_bob):
2020
In this approach you have a series of `if` statements using the calculated variables to evaluate the conditions.
2121
As soon as a `True` condition is found, the correct response is returned.
2222

23-
```exercism/note
23+
~~~~exercism/note
2424
Note that there are no `elif` or `else` statements.
2525
If an `if` statement can return, then an `elif` or `else` is not needed.
2626
Execution will either return or will continue to the next statement anyway.
27-
```
27+
~~~~
2828

2929
The [`rstrip`][rstrip] method is applied to the input to eliminate any whitespace at the end of the input.
3030
If the input has no characters left, it uses the [falsiness][falsiness] of an empty string with the [`not`][not] operator to return the response for saying nothing.
3131
Since it doesn't matter if there is leading whitespace, the `rstrip` function is used instead of [`strip`][strip].
3232

3333
The [`isupper`][isupper] method is used to test that there is at least one cased character and that all cased characters are uppercase.
3434

35-
```exercism/note
35+
~~~~exercism/note
3636
A cased character is one which differs between lowercase and uppercase.
3737
For example, `?` and `3` are not cased characters, as they do not change between lowercase and uppercase.
3838
`a` and `z` are cased characters, since their lowercase form changes to `A` and ` Z` when uppercase.
39-
```
39+
~~~~
4040

4141
The [`endswith`][endswith] method is used to determine if the input ends with a question mark.
4242

exercises/practice/etl/.docs/instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ This needs to be changed to store each individual letter with its score in a one
2222

2323
As part of this change, the team has also decided to change the letters to be lower-case rather than upper-case.
2424

25-
```exercism/note
25+
~~~~exercism/note
2626
If you want to look at how the data was previously structured and how it needs to change, take a look at the examples in the test suite.
27-
```
27+
~~~~

exercises/practice/gigasecond/.docs/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ Then we can use metric system prefixes for writing large numbers of seconds in m
1313
- Perhaps you and your family would travel to somewhere exotic for two megaseconds (that's two million seconds).
1414
- And if you and your spouse were married for _a thousand million_ seconds, you would celebrate your one gigasecond anniversary.
1515

16-
```exercism/note
16+
~~~~exercism/note
1717
If we ever colonize Mars or some other planet, measuring time is going to get even messier.
1818
If someone says "year" do they mean a year on Earth or a year on Mars?
1919
2020
The idea for this exercise came from the science fiction novel ["A Deepness in the Sky"][vinge-novel] by author Vernor Vinge.
2121
In it the author uses the metric system as the basis for time measurements.
2222
2323
[vinge-novel]: https://www.tor.com/2017/08/03/science-fiction-with-something-for-everyone-a-deepness-in-the-sky-by-vernor-vinge/
24-
```
24+
~~~~

exercises/practice/grains/grains_test.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# These tests are auto-generated with test data from:
22
# https://github.com/exercism/problem-specifications/tree/main/exercises/grains/canonical-data.json
3-
# File last updated on 2023-07-19
3+
# File last updated on 2023-09-27
44

55
import unittest
66

@@ -32,19 +32,19 @@ def test_grains_on_square_32(self):
3232
def test_grains_on_square_64(self):
3333
self.assertEqual(square(64), 9223372036854775808)
3434

35-
def test_square_0_raises_an_exception(self):
35+
def test_square_0_is_invalid(self):
3636
with self.assertRaises(ValueError) as err:
3737
square(0)
3838
self.assertEqual(type(err.exception), ValueError)
3939
self.assertEqual(err.exception.args[0], "square must be between 1 and 64")
4040

41-
def test_negative_square_raises_an_exception(self):
41+
def test_negative_square_is_invalid(self):
4242
with self.assertRaises(ValueError) as err:
4343
square(-1)
4444
self.assertEqual(type(err.exception), ValueError)
4545
self.assertEqual(err.exception.args[0], "square must be between 1 and 64")
4646

47-
def test_square_greater_than_64_raises_an_exception(self):
47+
def test_square_greater_than_64_is_invalid(self):
4848
with self.assertRaises(ValueError) as err:
4949
square(65)
5050
self.assertEqual(type(err.exception), ValueError)

exercises/practice/isogram/.approaches/scrub-regex/content.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ def is_isogram(phrase):
1212

1313
For this approach, [regular expression][regex], also known as a [regex][regex-how-to], is used to scrub the input phrase [str][str]ing.
1414
- In the pattern of `[^a-zA-Z]` the brackets are used to define a character set that looks for characters which are _not_ `a` through `z` and `A` through `Z`.
15-
```exercism/note
15+
~~~~exercism/note
1616
If the first character of a character set is `^`, all the characters that are _not_ in the rest of the character set will be matched.
17-
```
17+
~~~~
1818
This essentially matches any characters which are not in the English alphabet.
1919
The pattern is passed to the [`compile()`][compile] method to construct a [regular expression object][regex-object].
2020
- The [`sub()`][sub] method is then called on the regex object.

0 commit comments

Comments
 (0)