source code documentation with questions and todos

src/RestrictedPython/compile.py

@@ -18,6 +18,11 @@ def _compile_restricted_mode(
         # Unrestricted Source Checks
         byte_code = compile(source, filename, mode=mode, flags=flags,
                             dont_inherit=dont_inherit)
+    # TODO: Should be an elif check if policy is subclass of
+    # RestrictionNodeTransformer any other object passed in as policy might
+    # throw an error or is a NodeVisitor subclass that could be initialized with
+    # three params.
+    # elif issubclass(policy, RestrictingNodeTransformer):
     else:
         c_ast = None
         try:
@@ -44,6 +49,7 @@ def _compile_restricted_mode(
         except TypeError as v:
             byte_code = None
             errors.append(v)
+    # TODO: returning a named tuple should be considered
     return byte_code, tuple(errors), warnings, used_names
 
 
@@ -146,4 +152,5 @@ def compile_restricted(
         raise TypeError('unknown mode %s', mode)
     if errors:
         raise SyntaxError(errors)
+    # TODO: logging of warnings should be discussed and considered.
     return byte_code