#102 generate.py: Directory.walk: Add comments to explain what @overload is doing here

Author: mpsijm

bin/generate.py

@@ -1229,6 +1229,8 @@ def __init__(
                             self.path,
                         )
 
+    # The @overload definitions are purely here for static typing reasons.
+    # This overload takes a single function as argument, which is used for both files and directories.
     @overload
     def walk(
         self,
@@ -1237,6 +1239,7 @@ def walk(
         dir_last=False,
     ): ...
 
+    # This overload takes one function for test cases and a separate function for directories.
     @overload
     def walk(
         self,
@@ -1246,6 +1249,9 @@ def walk(
         dir_last=False,
     ): ...
 
+    # Below is the actual implementation of `walk`,
+    # no parameter types are needed here because they are already defined by the @overloads.
+
     # Map a function over all test cases directory tree.
     # dir_f by default reuses testcase_f
     def walk(self, testcase_f=None, dir_f=True, *, dir_last=False):