summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/machine.Timer.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-01-28 12:08:25 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-01-28 12:08:25 +0300
commit0aa83142a42f07675a21f8d223dc97b7da0194e4 (patch)
tree314684c6bc52c17c324b906f151fa60bcd366c06 /docs/library/machine.Timer.rst
parent56e7ebf07af8d570aadfe53b4686d014af574bf3 (diff)
downloadmicropython-0aa83142a42f07675a21f8d223dc97b7da0194e4.tar.gz
micropython-0aa83142a42f07675a21f8d223dc97b7da0194e4.zip
docs/machine: Add explicit note on machine module level and scope.
It's very low, hardware level, with associated constraints on operations and callbacks.
Diffstat (limited to 'docs/library/machine.Timer.rst')
-rw-r--r--docs/library/machine.Timer.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/library/machine.Timer.rst b/docs/library/machine.Timer.rst
index 318443348e..eddb2ce780 100644
--- a/docs/library/machine.Timer.rst
+++ b/docs/library/machine.Timer.rst
@@ -10,6 +10,9 @@ defines a baseline operation of executing a callback with a given period
(or once after some delay), and allow specific boards to define more
non-standard behavior (which thus won't be portable to other boards).
+See discussion of :ref:`important constraints <machine_callbacks>` on
+Timer callbacks.
+
.. note::
Memory can't be allocated inside irq handlers (an interrupt) and so