summaryrefslogtreecommitdiff
path: root/shared-bindings/help.c
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2018-02-27 22:03:52 -0500
committerGitHub <noreply@github.com>2018-02-27 22:03:52 -0500
commit568c04e6afa8016062f685b2198c0209f62827f4 (patch)
treed07b76119f715add462983b335797adf64b61249 /shared-bindings/help.c
parent6a2379fd0bfe10017d8abc5c36ef1d470c0d9b27 (diff)
parentea633117d01d94e8d56ed94344e4b3e46b4eef03 (diff)
Merge pull request #650 from tannewt/merge_2x3.0.0-alpha.2
Merge in commits from 2.x branch.
Diffstat (limited to 'shared-bindings/help.c')
-rw-r--r--shared-bindings/help.c9
1 files changed, 9 insertions, 0 deletions
diff --git a/shared-bindings/help.c b/shared-bindings/help.c
index a3ae94797..cdd9a4a93 100644
--- a/shared-bindings/help.c
+++ b/shared-bindings/help.c
@@ -26,6 +26,15 @@
#include "genhdr/mpversion.h"
+//| :func:`help` - Built-in method to provide helpful information
+//| ==============================================================
+//|
+//| .. method:: help(object=None)
+//|
+//| Prints a help method about the given object. When ``object`` is none,
+//| prints general port information.
+//|
+
const char *circuitpython_help_text =
"Welcome to Adafruit CircuitPython " MICROPY_GIT_TAG "!\r\n"
"\r\n"