Merge pull request #587 from bosh/more_code_formatting

More code formatting

Author: bosh

docs/code/BCP_Protocol/index.md

@@ -51,19 +51,19 @@ In all commands referenced below, the `\n` terminator is implicit. Some characte
 
 When a connection is initially established, the pinball controller transmits the following command:
 
-```
+``` console
 hello?version=1.0
 ```
 
 …where 1.0 is the version of the Backbox protocol it wants to speak. The media controller may reply with one of two responses:
 
-```
+``` console
 hello?version=1.0
 ```
 
 …indicating that it can speak the protocol version named, and reporting the version it speaks, or
 
-```
+``` console
 error?message=unknown protocol version
 ```
 

docs/code/BCP_Protocol/mode_list.md

@@ -11,7 +11,7 @@ Pin controller
 Type: JSON Array
 
 Example (Formatted for legibility; the parameter does not contain line-breaks):
-```
+``` json
 {
     "running_modes": [
         [
@@ -29,4 +29,4 @@ Example (Formatted for legibility; the parameter does not contain line-breaks):
 Each element of the array is another JSON Array with the following elements:
 
 1. The name of the mode (`string`)
-2. The priority of the mode (`int`)
+2. The priority of the mode (`int`)

docs/code/BCP_Protocol/switch.md

@@ -1,13 +1,13 @@
 # switch (BCP command)
 Indicates that the other side should process the changed state of a switch. When sent from the media controller to the pin controller, this is typically used to implement a virtual keyboard interface via the media controller (where the player can activate pinball machine switches via keyboard keys for testing). For example, for the media controller to tell the pin controller that the player just pushed the start button, the command would be:
 
-```
+``` console
 switch?name=start&state=1
 ```
 
 followed very quickly by
 
-```
+``` console
 switch?name=start&state=0
 ```
 
@@ -17,7 +17,8 @@ When sent from the pin controller to the media controller, this is used to send
 Pin controller or media controller
 
 ## Parameters
-## name
+
+### name
 Type: `string`
 
 This is the name of the switch.

docs/code/Writing_Tests/RunUnitTests.md

@@ -3,7 +3,7 @@
 
 Once MPF is installed, you can run some automated tests to make sure that everything is working. To do this, open a command prompt, and then type the following command and then press <enter>:
 
-```
+``` console
 python3 -m unittest discover mpf/tests
 ```
 
@@ -13,7 +13,7 @@ When you do this, you should see a bunch of dots on the screen (one for each tes
 
 The important thing is that when the tests are done, you should have a message like this:
 
-```
+``` console
 Ran 587 tests in 27.121s
 
 OK
@@ -27,7 +27,7 @@ These tests are the actual tests that the developers of MPF use to test MPF itse
 
 Remember though that MPF is actually two separate parts, the MPF game engine and the MPF media controller. The command you run just tested the game engine, so now let’s test the media controller. To do this, run the following command (basically the same thing as last time but with an “mc” added to the end, like this):
 
-```
+``` console
 python3 -m unittest discover mpfmc/tests
 ```
 

docs/code/Writing_Tests/WritingCustomTestsForYourMachine.md

@@ -51,7 +51,7 @@ These test methods will also load the machine config files (just like if the com
 
 Anyway, in our test method, we have the only actual line that does anything:
 
-```
+``` python
 self.assertModeRunning('attract')
 ```
 
@@ -63,7 +63,7 @@ You can run your tests via the command prompt from your machine folder. (In othe
 
 The exact command to run is `python -m unittest`. This should produce output similar to the following:
 
-```
+``` console
 C:\pinball\your_machine>python -m unittest
 C:\Python34\lib\imp.py:32: PendingDeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
   PendingDeprecationWarning)
@@ -82,13 +82,13 @@ That warning about the deprecation can be ignored (if you even have it.. you mig
 
 When you’re writing unit tests, you’ll end up dealing with failed tests a lot! So let’s purposefully change the test so it fails. In this case, change the line which asserts a mode called “attract” is running to look for a mode called “foo” instead, like this:
 
-```
+``` python
 self.assertModeRunning('foo')
 ```
 
 Save the file and rerun the tests and you should see results like this:
 
-```
+``` console
 C:\pinball\your_machine>python -m unittest
 C:\Python34\lib\imp.py:32: PendingDeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
   PendingDeprecationWarning)

docs/code/api_reference/misc_components/Players.md

@@ -17,15 +17,15 @@ This Player class is responsible for tracking player variables which is a dictio
 
 First, player variables can be accessed as attributes of the player object directly. For example, to set a player variable foo for the current player, you could use:
 
-```
+``` python
 self.machine.player.foo = 0
 ```
 
 If that variable didn’t exist, it will be automatically created.
 
 You can get the value of player variables by accessing them directly. For example:
 
-```
+``` python
 print(self.machine.player.foo)  # prints 0
 ```
 
@@ -44,7 +44,7 @@ For the change parameter, it will attempt to subtract the old value from the new
 
 For examples, the following three lines:
 
-```
+``` python
 self.machine.player.score = 0
 self.machine.player.score += 500
 self.machine.player.score = 1200

docs/code/api_reference/misc_components/RGBAColor.md

@@ -34,6 +34,9 @@ Parameters:
 
 Returns: An RGBColor object that is a blend between the start and end
 
+`red`
+
+Return the red component of the RGB color representation.
 
 `blue`
 
@@ -54,7 +57,7 @@ Convert a HEX color representation to an RGB color representation.
 Parameters:
 
 * **hex_string** – The 3- or 6-char hexadecimal string representing the color value.
-* **default** – The default value to return if _hex is invalid.
+* **default** – The default value to return if \_hex is invalid.
 
 Returns: RGB representation of the input HEX value as a 3-item tuple
 with each item being an integer 0-255.
@@ -76,9 +79,6 @@ If the name is not found, the default value is returned. :param name: A standard
 Generate a uniformly random RGB value.
 Returns:	A tuple of three integers with values between 0 and 255 inclusive
 
-`red`
-
-Return the red component of the RGB color representation.
 
 `rgb`
 
@@ -88,7 +88,7 @@ Return an RGB representation of the color.
 
 Convert an RGB color representation to a HEX color representation.
 
-```
+``` python
 (r, g, b) :: r -> [0, 255]
 g -> [0, 255] b -> [0, 255]
 ```

docs/code/api_reference/misc_components/RGBColor.md

@@ -32,9 +32,13 @@ Parameters:
 * **end_color** – The end color
 * **fraction** – The fraction between 0 and 1 that is used to set the blend point between the two colors.
 
-Returns: An RGBColor object that is a blend between the start and end
+Returns: An RGBColor object that is a blend between the start and end.
 
 
+`red`
+
+Return the red component of the RGB color representation.
+
 `blue`
 
 Return the blue component of the RGB color representation.
@@ -54,7 +58,7 @@ Convert a HEX color representation to an RGB color representation.
 Parameters:
 
 * **hex_string** – The 3- or 6-char hexadecimal string representing the color value.
-* **default** – The default value to return if _hex is invalid.
+* **default** – The default value to return if \_hex is invalid.
 
 Returns: RGB representation of the input HEX value as a 3-item tuple
 with each item being an integer 0-255.
@@ -76,19 +80,15 @@ If the name is not found, the default value is returned. :param name: A standard
 Generate a uniformly random RGB value.
 Returns:	A tuple of three integers with values between 0 and 255 inclusive
 
-`red
+`rgb`
 
-Return the red component of the RGB color representation.
-
-`rgb
-`
 Return an RGB representation of the color.
 
 `static rgb_to_hex(rgb: Tuple[int, int, int]) → str`
 
 Convert an RGB color representation to a HEX color representation.
 
-```
+``` python
 (r, g, b) :: r -> [0, 255]
 g -> [0, 255] b -> [0, 255]
 ```

docs/code/api_reference/misc_components/UtilityFunctions.md

@@ -55,22 +55,22 @@ For example, in the traditional python dictionary update() methods, if a diction
 
 Consider the following example:
 
-Original dictionary: config[‘foo’][‘bar’] = 1
+Original dictionary: `config['foo']['bar'] = 1`
 
-New dictionary we’re merging in: config[‘foo’][‘other_bar’] = 2
+New dictionary we’re merging in: `config['foo']['other_bar'] = 2`
 
 Default python dictionary update() method would have the updated dictionary as this:
 
-```
-{‘foo’: {‘other_bar’: 2}}
+``` python
+{'foo': {'other_bar': 2}}
 ```
 
 This happens because the original dictionary which had the single key bar was overwritten by a new dictionary which has a single key other_bar.)
 
 But really we want this:
 
-```
-{‘foo’: {‘bar’: 1, ‘other_bar’: 2}}
+``` python
+{'foo': {'bar': 1, 'other_bar': 2}}
 ```
 
 This code was based on this: https://www.xormedia.com/recursively-merge-dictionaries-in-python/