. d format and update markdown snippets

Author: actions-user

README.md

@@ -171,7 +171,7 @@ class TestSelectReporterFromClass(unittest.TestCase):
     def test_simple(self):
         verify("Hello", options=Options().with_reporter(report_with_beyond_compare()))
 ```
-<sup><a href='/tests/samples/test_getting_started.py#L25-L31' title='Snippet source file'>snippet source</a> | <a href='#snippet-select_reporter_from_class' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/samples/test_getting_started.py#L27-L33' title='Snippet source file'>snippet source</a> | <a href='#snippet-select_reporter_from_class' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 You can also use the `GenericDiffReporterFactory` to find and select the first diff utility that exists on our system.
@@ -182,6 +182,7 @@ An advantage of this method is you can modify the reporters.json file directly t
 <a id='snippet-select_reporter_from_factory'></a>
 ```py
 class TestSelectReporter(unittest.TestCase):
+    @override
     def setUp(self):
         self.factory = GenericDiffReporterFactory()
 
@@ -190,7 +191,7 @@ class TestSelectReporter(unittest.TestCase):
             "Hello", options=Options().with_reporter(self.factory.get("BeyondCompare"))
         )
 ```
-<sup><a href='/tests/samples/test_getting_started.py#L11-L22' title='Snippet source file'>snippet source</a> | <a href='#snippet-select_reporter_from_factory' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/samples/test_getting_started.py#L12-L24' title='Snippet source file'>snippet source</a> | <a href='#snippet-select_reporter_from_factory' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Or you can build your own GenericDiffReporter on the fly
@@ -207,7 +208,7 @@ class GettingStartedTest(unittest.TestCase):
             ),
         )
 ```
-<sup><a href='/tests/samples/test_getting_started.py#L34-L45' title='Snippet source file'>snippet source</a> | <a href='#snippet-custom_generic_diff_reporter' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/samples/test_getting_started.py#L36-L47' title='Snippet source file'>snippet source</a> | <a href='#snippet-custom_generic_diff_reporter' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 As long as `C:/my/favorite/diff/utility.exe` can be invoked from the command line using the format `utility.exe file1 file2`

approval_utilities/utilities/string_wrapper.py

@@ -1,4 +1,6 @@
 from typing_extensions import override
+
+
 class StringWrapper:
     def __init__(self) -> None:
         self.string = ""

approvaltests/approval_exception.py

@@ -1,4 +1,6 @@
 from typing_extensions import override
+
+
 class ApprovalException(Exception):
     def __init__(self, value: str) -> None:
         super().__init__(self)

approvaltests/reporter_missing_exception.py

@@ -1,4 +1,6 @@
 from typing_extensions import override
+
+
 class ReporterMissingException(BaseException):
     def __init__(self, key: str) -> None:
         super().__init__(self)

approvaltests/reporters/python_native_reporter.py

@@ -1,4 +1,5 @@
 from typing_extensions import override
+
 #!/usr/bin/env python
 
 import os

docs/how_to/create_a_custom_reporter.md

@@ -16,6 +16,7 @@ def load_ndarray(path):
         return np.load(f)
 
 class NDArrayDiffReporter(Reporter):
+    @override
     def report(self, received_path: str, approved_path: str) -> bool:
         if not Path(approved_path).is_file():
             self._create_empty_array(approved_path)
@@ -27,5 +28,5 @@ class NDArrayDiffReporter(Reporter):
         print(np.testing.build_err_msg([received, approved], err_msg=to_approve_msg))
         return True
 ```
-<sup><a href='/tests/test_example_numpy.py#L31-L51' title='Snippet source file'>snippet source</a> | <a href='#snippet-numpy_custom_reporter' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/test_example_numpy.py#L32-L53' title='Snippet source file'>snippet source</a> | <a href='#snippet-numpy_custom_reporter' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->

docs/how_to/create_custom_verify_methods.md

@@ -58,6 +58,7 @@ def test_verifiable(self):
             self.title = title
             self.text = text
 
+        @override
         def __str__(self) -> str:
             return remove_indentation_from(
                 f""" 
@@ -66,13 +67,14 @@ def test_verifiable(self):
             """
             )
 
+        @override
         def get_verify_parameters(self, options: Options) -> VerifyParameters:
             return VerifyParameters(options.for_file.with_extension(".md"))
 
     verify(
         MarkdownParagraph("Paragraph Title", "This is where the paragraph text is.")
     )
 ```
-<sup><a href='/tests/test_verify.py#L304-L326' title='Snippet source file'>snippet source</a> | <a href='#snippet-verifiable_object_example' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/test_verify.py#L310-L334' title='Snippet source file'>snippet source</a> | <a href='#snippet-verifiable_object_example' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 

docs/how_to/test_combinations_of_inputs.md

@@ -32,7 +32,7 @@ If you wanted to test this matrix combination approvals can do it with a single
 ```py
 verify_all_combinations(is_awake, [["Monday", "Sunday"], ["7:00", "9:00", "11:00"]])
 ```
-<sup><a href='/tests/test_combinations.py#L149-L151' title='Snippet source file'>snippet source</a> | <a href='#snippet-combination_introduction' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/test_combinations.py#L152-L154' title='Snippet source file'>snippet source</a> | <a href='#snippet-combination_introduction' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 ## When to use Combinations
@@ -52,7 +52,7 @@ inputs1 = ["input1.value1", "input1.value2"]
 inputs2 = ["input2.value1", "input2.value2", "input2.value3"]
 verify_all_combinations(lambda a, b: "placeholder", [inputs1, inputs2])
 ```
-<sup><a href='/tests/test_combinations.py#L155-L159' title='Snippet source file'>snippet source</a> | <a href='#snippet-combinations_starting_point' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/test_combinations.py#L158-L162' title='Snippet source file'>snippet source</a> | <a href='#snippet-combinations_starting_point' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 2. Modify each input container for your chosen values.
@@ -92,7 +92,7 @@ verify_all_combinations_with_labeled_input(
     arg2=(2, 4),
 )
 ```
-<sup><a href='/tests/test_combinations.py#L126-L132' title='Snippet source file'>snippet source</a> | <a href='#snippet-named_combinations' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/test_combinations.py#L128-L134' title='Snippet source file'>snippet source</a> | <a href='#snippet-named_combinations' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 which will produce the following output:

docs/how_to/verify-binary.md

@@ -24,7 +24,7 @@ filename = get_adjacent_file(name)
 with open(filename, mode="rb") as f:
     verify_binary(f.read(), ".png")
 ```
-<sup><a href='/tests/test_verify.py#L179-L184' title='Snippet source file'>snippet source</a> | <a href='#snippet-verify_binary_image' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/test_verify.py#L183-L188' title='Snippet source file'>snippet source</a> | <a href='#snippet-verify_binary_image' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Which will produce
@@ -47,7 +47,7 @@ def test_simulator_produces_correct_output():
         options=Options().with_reporter(NDArrayDiffReporter()),
     )
 ```
-<sup><a href='/tests/test_example_numpy.py#L16-L26' title='Snippet source file'>snippet source</a> | <a href='#snippet-verify_numpy_array' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/test_example_numpy.py#L17-L27' title='Snippet source file'>snippet source</a> | <a href='#snippet-verify_numpy_array' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 It also shows the use of a custom reporter, which uses the NumPy testing features to produce a well-formatted error report highlighting the differences between arrays.
@@ -60,6 +60,7 @@ def load_ndarray(path):
         return np.load(f)
 
 class NDArrayDiffReporter(Reporter):
+    @override
     def report(self, received_path: str, approved_path: str) -> bool:
         if not Path(approved_path).is_file():
             self._create_empty_array(approved_path)
@@ -71,5 +72,5 @@ class NDArrayDiffReporter(Reporter):
         print(np.testing.build_err_msg([received, approved], err_msg=to_approve_msg))
         return True
 ```
-<sup><a href='/tests/test_example_numpy.py#L31-L51' title='Snippet source file'>snippet source</a> | <a href='#snippet-numpy_custom_reporter' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/test_example_numpy.py#L32-L53' title='Snippet source file'>snippet source</a> | <a href='#snippet-numpy_custom_reporter' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->

docs/reference/storyboard.md

@@ -29,7 +29,7 @@ ascii_wheel.advance()
 story.add_frame(ascii_wheel)
 verify(story)
 ```
-<sup><a href='/tests/test_verify.py#L228-L235' title='Snippet source file'>snippet source</a> | <a href='#snippet-use_storyboard' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/tests/test_verify.py#L233-L240' title='Snippet source file'>snippet source</a> | <a href='#snippet-use_storyboard' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 will produce