summaryrefslogtreecommitdiff
path: root/shared-bindings/help.c
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/help.c
parent25ae844d555b489eebd1ca3e80cc34f67182e205 (diff)
Improve docs and update to CircuitPython.
Diffstat (limited to 'shared-bindings/help.c')
-rw-r--r--shared-bindings/help.c9
1 files changed, 6 insertions, 3 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) {