Comment explaining the frame_context() function.

python · rwbarton · Jun 26, 2016 · Jun 22, 2016 · Jun 22, 2016 · Jun 22, 2016
commit 9d14b237f3e7dbd384dbbd01c3c7998f35e53ec0
diff --git a/mypy/checker.py b/mypy/checker.py
@@ -340,6 +340,17 @@ def pop_loop_frame(self) -> None:
 
     def frame_context(self, fall_through: bool = False,
                       clear_breaking: bool = False) -> 'FrameContextManager':
+        """Return a context manager that pushes/pops frames on enter/exit.
+
+        If fall_through, then allow types to escape from the inner
+        frame to the resulting frame.  That is, the state of types at
+        the end of the last frame are allowed to fall through into the
+        enclosing frame.
+
+        If clear_breaking, then on __exit__ the manager will clear the
+        breaking_out flag, and if it was not set, will allow the frame
+        to escape to its grandparent.
+        """
         return FrameContextManager(self, fall_through, clear_breaking)