summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2017-09-06 17:50:00 -0400
committerGitHub <noreply@github.com>2017-09-06 17:50:00 -0400
commite0ddd528c8552ad5242cdd956b7f9763019c46fe (patch)
treef4bfd9cd070d56786c26cf54dc7b9711d83b7b70
parent6467e3d40b0297f88ccbad8fa565aa3790c2931a (diff)
Add Processor to microcontroller documentation TOC (#237)
-rw-r--r--shared-bindings/microcontroller/__init__.c6
1 files changed, 4 insertions, 2 deletions
diff --git a/shared-bindings/microcontroller/__init__.c b/shared-bindings/microcontroller/__init__.c
index 0546ebf30..d2567bd65 100644
--- a/shared-bindings/microcontroller/__init__.c
+++ b/shared-bindings/microcontroller/__init__.c
@@ -58,17 +58,19 @@
//| :maxdepth: 3
//|
//| Pin
+//| Processor
//|
//| .. attribute:: cpu
//|
-//| CPU information and control, such as temperature and clock frequency.
+//| CPU information and control, such as `cpu.temperature` and `cpu.frequency`
+//| (clock frequency).
//| This object is the sole instance of `microcontroller.Processor`.
//|
//| .. method:: delay_us(delay)
//|
-//| Dedicated delay method used for very short delays. DO NOT do long delays
+//| Dedicated delay method used for very short delays. **Do not** do long delays
//| because it will stall any concurrent code.
//|
STATIC mp_obj_t mcu_delay_us(mp_obj_t delay_obj) {