summaryrefslogtreecommitdiff
path: root/shared-bindings
diff options
context:
space:
mode:
authorScott Shawcroft <scott.shawcroft@gmail.com>2017-01-05 16:20:46 -0800
committerScott Shawcroft <scott.shawcroft@gmail.com>2017-01-05 16:20:46 -0800
commit7c302c395ec699738bade269673c06a38cbedbff (patch)
tree56280be561c525e52e7823c76e7b4645ff17442c /shared-bindings
parent25ae844d555b489eebd1ca3e80cc34f67182e205 (diff)
Improve docs and update to CircuitPython.
Diffstat (limited to 'shared-bindings')
-rw-r--r--shared-bindings/help.c9
-rw-r--r--shared-bindings/index.rst1
-rw-r--r--shared-bindings/microcontroller/__init__.c16
-rw-r--r--shared-bindings/nativeio/__init__.c2
-rw-r--r--shared-bindings/uheap/__init__.c6
5 files changed, 20 insertions, 14 deletions
diff --git a/shared-bindings/help.c b/shared-bindings/help.c
index dfdd72680..ef819a366 100644
--- a/shared-bindings/help.c
+++ b/shared-bindings/help.c
@@ -27,10 +27,13 @@
#include "lib/utils/pyhelp.h"
#include "shared-bindings/help.h"
-//| .. method:: help(object=None)
+//| :func:`help` - Built-in method to provide helpful information
+//| ========================================================
//|
-//| Prints a help method about the given object. When ``object`` is none,
-//| prints general port information.
+//| .. method:: help(object=None)
+//|
+//| Prints a help method about the given object. When ``object`` is none,
+//| prints general port information.
//|
STATIC mp_obj_t pyb_help(uint n_args, const mp_obj_t *args) {
if (n_args == 0) {
diff --git a/shared-bindings/index.rst b/shared-bindings/index.rst
index c1c63276c..ebea3c16a 100644
--- a/shared-bindings/index.rst
+++ b/shared-bindings/index.rst
@@ -10,3 +10,4 @@ follow.
:maxdepth: 3
*/__init__
+ help
diff --git a/shared-bindings/microcontroller/__init__.c b/shared-bindings/microcontroller/__init__.c
index 031bfe35c..214436687 100644
--- a/shared-bindings/microcontroller/__init__.c
+++ b/shared-bindings/microcontroller/__init__.c
@@ -43,7 +43,7 @@
//|
//| .. module:: microcontroller
//| :synopsis: Pin references and core functionality
-//| :platform: SAMD21
+//| :platform: SAMD21, ESP8266
//|
//| The `microcontroller` module defines the pins from the perspective of the
//| microcontroller. See `board` for board-specific pin mappings.
@@ -56,10 +56,10 @@
//| Pin
//|
-//| .. method:: delay_us(delay)
+//| .. method:: delay_us(delay)
//|
-//| Dedicated delay method used for very short delays. DO NOT do long delays
-//| because it will stall any concurrent code.
+//| 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) {
uint32_t delay = mp_obj_get_int(delay_obj);
@@ -70,9 +70,9 @@ STATIC mp_obj_t mcu_delay_us(mp_obj_t delay_obj) {
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mcu_delay_us_obj, mcu_delay_us);
-//| .. method:: disable_interrupts()
+//| .. method:: disable_interrupts()
//|
-//| Disable all interrupts. Be very careful, this can stall everything.
+//| Disable all interrupts. Be very careful, this can stall everything.
//|
STATIC mp_obj_t mcu_disable_interrupts(void) {
common_hal_mcu_disable_interrupts();
@@ -80,9 +80,9 @@ STATIC mp_obj_t mcu_disable_interrupts(void) {
}
STATIC MP_DEFINE_CONST_FUN_OBJ_0(mcu_disable_interrupts_obj, mcu_disable_interrupts);
-//| .. method:: enable_interrupts()
+//| .. method:: enable_interrupts()
//|
-//| Enable the interrupts that were enabled at the last disable.
+//| Enable the interrupts that were enabled at the last disable.
//|
STATIC mp_obj_t mcu_enable_interrupts(void) {
common_hal_mcu_enable_interrupts();
diff --git a/shared-bindings/nativeio/__init__.c b/shared-bindings/nativeio/__init__.c
index 9bcc252cd..3d4b8c823 100644
--- a/shared-bindings/nativeio/__init__.c
+++ b/shared-bindings/nativeio/__init__.c
@@ -76,6 +76,8 @@
//| I2C
//| PWMOut
//| SPI
+//| TouchIn
+//| UART
//|
//| All libraries change hardware state and should be deinitialized when they
//| are no longer needed. To do so, either call :py:meth:`!deinit` or use a
diff --git a/shared-bindings/uheap/__init__.c b/shared-bindings/uheap/__init__.c
index 55050cfa3..df18237ac 100644
--- a/shared-bindings/uheap/__init__.c
+++ b/shared-bindings/uheap/__init__.c
@@ -38,10 +38,10 @@
//| :synopsis: Heap size analysis
//|
-//| .. method:: info(object)
+//| .. method:: info(object)
//|
-//| Prints memory debugging info for the given object and returns the
-//| estimated size.
+//| Prints memory debugging info for the given object and returns the
+//| estimated size.
//|
STATIC mp_obj_t uheap_info(mp_obj_t obj) {
uint32_t size = shared_module_uheap_info(obj);