Update end_to_end_tests/test_end_to_end.py / doctring imprv

Co-authored-by: Dylan Anthony <[email protected]>

Author: p1-ra

Diff for: end_to_end_tests/test_end_to_end.py

@@ -17,6 +17,15 @@ def _compare_directories(
     ] = None,  # key: path relative to generated directory, value: expected generated content
     depth=0,
 ):
+    """
+    Compare two directories and assert that only expected_differences are different
+
+    Args:
+        record: Path to the expected output
+        test_subject: Path to the generated code being checked
+        expected_differences: key: path relative to generated directory, value: expected generated content
+        depth: Used to track recursion
+    """
     first_printable = record.relative_to(Path.cwd())
     second_printable = test_subject.relative_to(Path.cwd())
     dc = dircmp(record, test_subject)