Format using Prettier

ErikSchierboom · cmccandless · commit 549b2d086f43 · 2021-01-29T11:14:36.000-05:00
[Docs] Format using Prettier
diff --git a/exercises/concept/strings/.docs/hints.md b/exercises/concept/strings/.docs/hints.md
@@ -4,23 +4,23 @@
 
 ### 1. Get message from a log line
 
- - Strings in Python have [lots of convenient instance methods][str-type-methods] for cleaning, splitting, manipulating, and creating new strings. Extracting values from a string could be done by splitting it based on a substring, for example.
+- Strings in Python have [lots of convenient instance methods][str-type-methods] for cleaning, splitting, manipulating, and creating new strings. Extracting values from a string could be done by splitting it based on a substring, for example.
 
 ### 2. Get log level from a log line
 
- - Strings also have methods that help convert letters from lower to uppercase and vice-versa.
+- Strings also have methods that help convert letters from lower to uppercase and vice-versa.
 
 ### 3. Reformat a log line
 
 Strings are immutable, but can be combined together to make new strings, or have elements replaced. This goal can be accomplished by using string methods, or operators like `+` or `+=` (which are overloaded to work with strings).
 Python also has a concept of string formatting, like many other languages.
 
- - The [`str.join()`][str-join] method is useful to join an iterable of strings into one string by interspersing them with a common value, e.g. `":".join("abcde")` would create `"a:b:c:d:e"`.
- - [`str.format()`][str-format] is an idiomatic way to do string interpolation in Python (inserting one or more string value(s) into another).
- - [Format strings][format-str] are another convenient way to interpolate values into a string. This strategy is particularly useful when more than one named variable needs to be inserted into a final output.
+- The [`str.join()`][str-join] method is useful to join an iterable of strings into one string by interspersing them with a common value, e.g. `":".join("abcde")` would create `"a:b:c:d:e"`.
+- [`str.format()`][str-format] is an idiomatic way to do string interpolation in Python (inserting one or more string value(s) into another).
+- [Format strings][format-str] are another convenient way to interpolate values into a string. This strategy is particularly useful when more than one named variable needs to be inserted into a final output.
 
- [python-str-doc]: https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str
- [str-type-methods]: https://docs.python.org/3/library/stdtypes.html#str
- [str-join]: https://docs.python.org/3/library/stdtypes.html#str.join
- [str-format]: https://docs.python.org/3/library/stdtypes.html#str.format
- [format-str]: https://docs.python.org/3/library/string.html#formatstrings
+[python-str-doc]: https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str
+[str-type-methods]: https://docs.python.org/3/library/stdtypes.html#str
+[str-join]: https://docs.python.org/3/library/stdtypes.html#str.join
+[str-format]: https://docs.python.org/3/library/stdtypes.html#str.format
+[format-str]: https://docs.python.org/3/library/string.html#formatstrings
diff --git a/exercises/concept/strings/.meta/design.md b/exercises/concept/strings/.meta/design.md
@@ -6,11 +6,11 @@ The goal of this exercise is to teach the student about Python strings, and fami
 
 ## Things to teach
 
- - Know that Python has a `str` type.
- - Know how to find items in a string.
- - Know how to manipulate strings to create new strings.
- - Familiarize one's self with string instance methods in Python.
- - Learn about string formatting.
+- Know that Python has a `str` type.
+- Know how to find items in a string.
+- Know how to manipulate strings to create new strings.
+- Familiarize one's self with string instance methods in Python.
+- Learn about string formatting.
 
 ## Things not to teach
 
@@ -21,11 +21,11 @@ The goal of this exercise is to teach the student about Python strings, and fami
 
 The Concepts this exercise unlocks are:
 
- - `strings-basic`: know about `str` type in Python, know some basic methods, know about formatting.
+- `strings-basic`: know about `str` type in Python, know some basic methods, know about formatting.
 
 ## Prerequisites
 
- - `functions`: The student should be familiar with creating functions.
+- `functions`: The student should be familiar with creating functions.
 
 ## Representer
 
diff --git a/reference/concepts/argument_unpacking.md b/reference/concepts/argument_unpacking.md
@@ -3,4 +3,3 @@
 TODO: ADD MORE
 
 - the example solution for this exercise uses `splat` (`*`) to unpack rows for the `zip()` function. [matrix](../exercise-concepts/matrix.md)
-
diff --git a/reference/concepts/assignment.md b/reference/concepts/assignment.md
@@ -5,4 +5,3 @@ TODO: ADD MORE
 - The example solution uses assignment for variables and other values. [markdown](../exercise-concepts/markdown.md)
 - instance properties need to be assigned passed in data [matrix](../exercise-concepts/matrix.md)
 - the example uses assignment for all the instance properties and `instructions` dictionary. [robot-simulator](../exercise-concepts/robot-simulator.md)
-
diff --git a/reference/concepts/builtin_functions/len.md b/reference/concepts/builtin_functions/len.md
@@ -9,4 +9,3 @@ See [docs][docs].
 [docs]: https://docs.python.org/3/library/functions.html#len
 [hamming]: ../../exercise-concepts/hamming.md
 [variable-length-quantity]: ../../exercise-concepts/variable-length-quantity.md
-
diff --git a/reference/concepts/builtin_functions/zip.md b/reference/concepts/builtin_functions/zip.md
@@ -9,4 +9,3 @@ See [docs][docs].
 [docs]: https://docs.python.org/3/library/functions.html#zip
 [hamming]: ../../exercise-concepts/hamming.md
 [matrix]: ../../exercise-concepts/matrix.md
-
diff --git a/reference/concepts/builtin_types/bytearray.md b/reference/concepts/builtin_types/bytearray.md
@@ -5,7 +5,6 @@ TODO: ADD MORE DETAIL
 See the Python documentation entries for the [binary sequence types][docs-binary-sequence-types], of which [`bytearray`][docs-bytearray-type] is the [mutable][mutation] member. You'll also want to familiarize yourself with the use of [`bytearray` as a casting function][docs-bytearray-as-function], as well as the many [common binary sequence methods][docs-binary-sequence-methods] and [mutable sequence methods][docs-mutable-sequence-methods] available to use on the type.
 
 [mutation]: ../../../../../reference/concepts/mutation.md
-
 [docs-binary-sequence-types]: https://docs.python.org/3/library/stdtypes.html#binaryseq
 [docs-bytearray-type]: https://docs.python.org/3/library/stdtypes.html#typebytearray
 [docs-bytearray-as-function]: https://docs.python.org/3/library/stdtypes.html#bytearray
diff --git a/reference/concepts/builtin_types/frozenset.md b/reference/concepts/builtin_types/frozenset.md
@@ -2,7 +2,7 @@
 
 TODO: ADD MORE DETAIL
 
-See the Python documentation entries for the [`set`][docs-set] collection, the [immutable] [set type][docs-set-type]; essentially a [hash map][hash-map] in which only the key is relevant, and which disallows [mutaion][mutation] of keys after intialization.
+See the Python documentation entries for the [`set`][docs-set] collection, the [immutable][set type][docs-set-type]; essentially a [hash map][hash-map] in which only the key is relevant, and which disallows [mutaion][mutation] of keys after intialization.
 
 [immutable]: ../../../../../reference/concepts/immutability.md
 [mutation]: ../../../../../reference/concepts/mutation.md
diff --git a/reference/concepts/builtin_types/list.md b/reference/concepts/builtin_types/list.md
@@ -1,6 +1,6 @@
 # `list`
 
-Lists are dynamic arrays that can be resized by Python at runtime. They are homogenous, meaning they are able to hold any data type, including other lists,  and can even contain themselves (recursive data structures are relatively simple in Python).
+Lists are dynamic arrays that can be resized by Python at runtime. They are homogenous, meaning they are able to hold any data type, including other lists, and can even contain themselves (recursive data structures are relatively simple in Python).
 
 Simple flat lists are used extensively in [variable-length-quantity][variable-length-quantity], [markdown][markdown], and [robot-simulator][robot-simulator].
 
diff --git a/reference/concepts/builtin_types/range.md b/reference/concepts/builtin_types/range.md
@@ -1,6 +1,6 @@
 # `range`
 
-The `range()` built-in represents an immutable sequence of numbers (or any object that implements the __index__ dunder method). Used in the [markdown][markdown] to control the number of loops while iterating through a passed-in line or list. Used in [robot-simulator][robot-simulator] to represent the values from zero to 3 as assigned to NORTH, EAST, SOUTH, WEST.
+The `range()` built-in represents an immutable sequence of numbers (or any object that implements the **index** dunder method). Used in the [markdown][markdown] to control the number of loops while iterating through a passed-in line or list. Used in [robot-simulator][robot-simulator] to represent the values from zero to 3 as assigned to NORTH, EAST, SOUTH, WEST.
 
 TODO: ADD MORE DETAIL
 
@@ -10,6 +10,5 @@ See the Python documentation entries for the [immutable][immutable] [`range` typ
 [docs-range-type]: https://docs.python.org/3/library/stdtypes.html#typesseq-range
 [docs-range-as-function]: https://docs.python.org/3/library/stdtypes.html#range
 [docs-sequence-types]: https://docs.python.org/3/library/stdtypes.html#typesseq
-
 [markdown]: ../../exercise-concepts/markdown.md
 [robot-simulator]: ../../exercise-concepts/robot-simulator.md
diff --git a/reference/concepts/builtin_types/str.md b/reference/concepts/builtin_types/str.md
@@ -4,7 +4,7 @@ Python's [string][general-concept-string] type, which always holds encoded [Unic
 
 A useful concept to know to solve the [hamming][hamming] exercise.
 
- TODO: ADD MORE DETAIL
+TODO: ADD MORE DETAIL
 
 See the Python documentation entries for the [immutable][immutability] [text sequence type][docs-text-sequence-type]. You'll also want to familiarize yourself with the use of [`str` as a casting function][docs-str-as-function], as well as the many [string methods][docs-string-methods] available to use on the type.
 
diff --git a/reference/concepts/dunder_methods.md b/reference/concepts/dunder_methods.md
@@ -6,5 +6,5 @@ TODO: ADD MORE
 - student needs to know when to use dunder methods `__init__` and `__str__` [binary-search-tree](../exercise-concepts/binary-search-tree.md)
 - "dunder" -> "double under", referring to the names of these methods being prefixed with two underscores, e.g. `__init__`. There is no formal privacy in Python, but conventionally a single underscore indicates a private method, or one that the programmer should assume may change at any time; methods without an underscore are considered part of an object's public API. Double underscores are even more special - they are used by Python's builtin functions like `len()`, for example, to allow objects to implement various interfaces and functionality. They can also be used for operator overloading. If you have a custom class that you would like to be able to compare to other instances of the same class, implementing `__lt__`, `__gt__`, `__eq__` etc. allow programmers to use the `>`, `<`, `=` operators. Dunder methods allow programmers to build useful objects with simple interfaces, i.e. you can add two instances together using `+` instead of writing something like `instance1.add(instance2)`. [hamming](../exercise-concepts/hamming.md)
 - the example uses the `__init__` magic method as its constructor for the class [matrix](../exercise-concepts/matrix.md)
-- User defined classes can (and generally do) overload the `__init__` method, whose first argument is `self`, because the result of `__init__` is a class *instance*. [phone-number](../exercise-concepts/phone-number.md)
+- User defined classes can (and generally do) overload the `__init__` method, whose first argument is `self`, because the result of `__init__` is a class _instance_. [phone-number](../exercise-concepts/phone-number.md)
 - The example uses `__init__` as a constructor for the class, which also calls `__new__`. In addition, the example uses `__call__()` via the appending of `()` to instance method names, and `__eq__()` (_rich compairison_) via the use of `==` [robot-simulator](../exercise-concepts/robot-simulator.md)
diff --git a/reference/concepts/equality_operator.md b/reference/concepts/equality_operator.md
@@ -2,4 +2,4 @@
 
 TODO: ADD MORE
 
-- the `==` operator calls the dunder method `__eq__()`. By default, objects of different types are never considered equal to each other unless they are numerical types (ie int, float) or have otherwise overloaded the default implementation of the `__eq__` dunder method. `==` is always defined, but for some object types (_like class objects_) it is equivalent to calling `is`. See [`__eq__`](https: //docs.python.org/3/reference/datamodel.html#object.__eq__) for additional details. This exercise uses the equality operator to test that the `self.direction` attribute is equal to one of the constant values defined. [robot-simulator](../exercise-concepts/robot-simulator.md)
+- the `==` operator calls the dunder method `__eq__()`. By default, objects of different types are never considered equal to each other unless they are numerical types (ie int, float) or have otherwise overloaded the default implementation of the `__eq__` dunder method. `==` is always defined, but for some object types (_like class objects_) it is equivalent to calling `is`. See [`__eq__`](https: //docs.python.org/3/reference/datamodel.html#object.**eq**) for additional details. This exercise uses the equality operator to test that the `self.direction` attribute is equal to one of the constant values defined. [robot-simulator](../exercise-concepts/robot-simulator.md)
diff --git a/reference/concepts/instance_methods.md b/reference/concepts/instance_methods.md
@@ -4,6 +4,6 @@ TODO: ADD MORE
 
 - the exercise relies on the `def` statement to create an instance method [allergies](../exercise-concepts/allergies.md)
 - use of `def` to define a class's methods [clock](../exercise-concepts/clock.md)
-- classes can have instance *methods* which are called from an instance of the class (as opposed to class methods, called from the Class itself). The first parameter of an instance method is always `self`, which is provided when calling from the instance (i.e. the programmer does not need to pass it as an argument explicitly). Static methods are methods called from the class itself, and are not connected to an instance of the class. They have access to class attributes (those defined on the class, not connected to the `self`), and do not require an instance of the class to exist. Classes can also define a `property` by using the `@property` decorator (not shown here); a `property` can be "lazily evaluated" to avoid uneeded computation [phone-number](../exercise-concepts/phone-number.md)
+- classes can have instance _methods_ which are called from an instance of the class (as opposed to class methods, called from the Class itself). The first parameter of an instance method is always `self`, which is provided when calling from the instance (i.e. the programmer does not need to pass it as an argument explicitly). Static methods are methods called from the class itself, and are not connected to an instance of the class. They have access to class attributes (those defined on the class, not connected to the `self`), and do not require an instance of the class to exist. Classes can also define a `property` by using the `@property` decorator (not shown here); a `property` can be "lazily evaluated" to avoid uneeded computation [phone-number](../exercise-concepts/phone-number.md)
 - tests for this exercises require one or more instance methods that will return a specified row or column list of the `matrix`. [matrix](../exercise-concepts/matrix.md)
 - tests for this exercises require one or more instance methods that will take in a set of starting coordinates and a bearing and then accept a series of instructions that "move" the instance to a new set of coordinates and bearing. [robot-simulator](../exercise-concepts/robot-simulator.md)
diff --git a/reference/concepts/iterables.md b/reference/concepts/iterables.md
@@ -4,5 +4,5 @@ TODO: ADD MORE
 
 - strings are iterable, which provides a lot of opportunity to leverage Python functions against them [hamming](../exercise-concepts/hamming.md)
 - understanding that strings, lists, and other data structures can be iterated over in the same fashion [matrix](../exercise-concepts/matrix.md)
-- characters in a string are *iterables* and are subject to index and slice access as described below [phone-number](../exercise-concepts/phone-number.md)
+- characters in a string are _iterables_ and are subject to index and slice access as described below [phone-number](../exercise-concepts/phone-number.md)
 - The example solution uses the `for _ in _` syntax to iterate over a list of lines. This is possible because a list is an `iterable`. [markdown](../exercise-concepts/markdown.md)
diff --git a/reference/concepts/pep_8_style_guide.md b/reference/concepts/pep_8_style_guide.md
@@ -1,6 +1,6 @@
 # PEP 8 Style
 
-Unlike most earlier languages -- and many newer -- Python has an "official" style guide, and has had one for quite some time. 
+Unlike most earlier languages -- and many newer -- Python has an "official" style guide, and has had one for quite some time.
 
 > One of [Python creator Guido von Rossum]'s key insights is that code is read much more often than it is written. The guidelines provided here are intended to improve the readability of code and make it consistent across the wide spectrum of Python code. As [PEP 20](zen_of_python.md) says, "Readability counts".
 
diff --git a/reference/concepts/star_args.md b/reference/concepts/star_args.md
@@ -1,3 +1,3 @@
 # `*args` for variadic arguments
 
-TODO: Explain the use of ``*args` for collecting up an unknown number of positional arguments in function signatures.
+TODO: Explain the use of `*args` for collecting up an unknown number of positional arguments in function signatures.
diff --git a/reference/concepts/star_star_kwargs.md b/reference/concepts/star_star_kwargs.md
@@ -1,3 +1,3 @@
 # `**kwargs` for variadic keyword arguments
 
-TODO: Explain the use of ``**kwargs` for collecting up a variable number of keyword arguments in function signatures.
+TODO: Explain the use of `**kwargs` for collecting up a variable number of keyword arguments in function signatures.
diff --git a/reference/concepts/zen_of_python.md b/reference/concepts/zen_of_python.md
@@ -17,7 +17,7 @@ The _Zen of Python_ by Tim Peters, and also known as [PEP-20](https://www.python
 - There should be one-- and preferably only one --obvious way to do it.
 - Although that way may not be obvious at first unless you're Dutch.
 - Now is better than never.
-- Although never is often better than *right* now.
+- Although never is often better than _right_ now.
 - If the implementation is hard to explain, it's a bad idea.
 - If the implementation is easy to explain, it may be a good idea.
 - Namespaces are one honking great idea -- let's do more of those!
diff --git a/reference/exercise-concepts/allergies.md b/reference/exercise-concepts/allergies.md
@@ -78,4 +78,3 @@ There are also various solutions involving lists, but these all come with O(N) l
 - [Property Decorator][property-decorator]: this exercise relies on the `@property` decorator to provide read-only dynamic access to the current list of allergens
 - [Membership Testing][membership-testing]: this exercise relies on testing membership of a value in a collection of values
 - [Lookup Efficiency][lookup-efficiency]: an efficient solution requires knowing that membership testing is O(1) in **dict** and the **enum.Enum** variants, but is O(N) in **list** and other sequential types
-
diff --git a/reference/exercise-concepts/binary-search-tree.md b/reference/exercise-concepts/binary-search-tree.md
@@ -80,4 +80,3 @@ class BinarySearchTree:
 - [Lists][lists]: knowledge of lists and iteration on lists is required for this exercise
 - [Conditional structures][conditional-structures]: knowledge of conditional conceptis and `if...else` statements are required
 - [Methods of list][methods-of-list]: the use of methods of list could be useful in this exercise. Methods like `append`, `pop`...
-
diff --git a/reference/exercise-concepts/hamming.md b/reference/exercise-concepts/hamming.md
diff --git a/reference/exercise-concepts/markdown.md b/reference/exercise-concepts/markdown.md
diff --git a/reference/exercise-concepts/matrix.md b/reference/exercise-concepts/matrix.md
diff --git a/reference/exercise-concepts/phone-number.md b/reference/exercise-concepts/phone-number.md
diff --git a/reference/exercise-concepts/reverse-string.md b/reference/exercise-concepts/reverse-string.md
diff --git a/reference/exercise-concepts/robot-simulator.md b/reference/exercise-concepts/robot-simulator.md
diff --git a/reference/exercise-concepts/variable-length-quantity.md b/reference/exercise-concepts/variable-length-quantity.md

Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,3 @@`
`3`	`3`	`TODO: ADD MORE`
`4`	`4`
`5`	`5`	- the example solution for this exercise uses `splat` (`*`) to unpack rows for the `zip()` function. [matrix](../exercise-concepts/matrix.md)
`6`		`-`