docs/library/machine: Add note on interrupts being critical to system.

ThinkTransit · dpgeorge · commit 3d58bb23c283 · 2022-06-21T17:25:11.000+10:00
diff --git a/docs/library/machine.rst b/docs/library/machine.rst
@@ -48,6 +48,23 @@ Reset related functions
 Interrupt related functions
 ---------------------------
 
+The following functions allow control over interrupts.  Some systems require
+interrupts to operate correctly so disabling them for long periods may
+compromise core functionality, for example watchdog timers may trigger
+unexpectedly.  Interrupts should only be disabled for a minimum amount of time
+and then re-enabled to their previous state.  For example::
+
+    import machine
+
+    # Disable interrupts
+    state = machine.disable_irq()
+
+    # Do a small amount of time-critical work here
+
+    # Enable interrupts
+    machine.enable_irq(state)
+
+
 .. function:: disable_irq()
 
    Disable interrupt requests.
