Document with_rebuilt.ignoring

JuliaPy · Aug 17, 2018 · a1f0b4b · a1f0b4b
1 parent 1d75179
commit a1f0b4b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/julia/with_rebuilt.py b/julia/with_rebuilt.py
@@ -51,6 +51,18 @@ def maybe_rebuild(rebuild, julia):
 
 @contextmanager
 def ignoring(sig):
+    """
+    Context manager for ignoring signal `sig`.
+
+    For example,::
+
+        with ignoring(signal.SIGINT):
+            do_something()
+
+    would ignore user's ctrl-c during ``do_something()``.  This is
+    useful when launching interactive program (in which ctrl-c is a
+    valid keybinding) from Python.
+    """
     s = signal.signal(sig, signal.SIG_IGN)
     try:
         yield