summaryrefslogtreecommitdiff
path: root/docs/library/micropython.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/micropython.rst')
-rw-r--r--docs/library/micropython.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/library/micropython.rst b/docs/library/micropython.rst
index c4706c4c6..7564f29ae 100644
--- a/docs/library/micropython.rst
+++ b/docs/library/micropython.rst
@@ -29,7 +29,8 @@ Functions
Allocate ``size`` bytes of RAM for the emergency exception buffer (a good
size is around 100 bytes). The buffer is used to create exceptions in cases
- when normal RAM allocation would fail (eg within an interrupt handler).
+ when normal RAM allocation would fail (eg within an interrupt handler) and
+ therefore give useful traceback information in these situations.
A good way to use this function is to put it at the start of your main script
(eg boot.py or main.py) and then the emergency exception buffer will be active