diff options
| author | Scott Shawcroft <scott@tannewt.org> | 2020-05-12 17:15:28 -0700 |
|---|---|---|
| committer | Scott Shawcroft <scott@tannewt.org> | 2020-05-12 17:28:24 -0700 |
| commit | 4e8de3c554024d3ac89e9ee77b958a6932a64bec (patch) | |
| tree | 4606c0cf69cef8a033aa2d95fab0811ddf49123a /shared-bindings/help.rst | |
| parent | c534a872a2b5a2d5e6b7543f56539afb24261443 (diff) | |
Swap sphinx to autoapi and the inline stubs
Diffstat (limited to 'shared-bindings/help.rst')
| -rw-r--r-- | shared-bindings/help.rst | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/shared-bindings/help.rst b/shared-bindings/help.rst new file mode 100644 index 000000000..63991bff2 --- /dev/null +++ b/shared-bindings/help.rst @@ -0,0 +1,31 @@ +# This file is part of the MicroPython project, http://micropython.org/ +# +# The MIT License (MIT) +# +# Copyright (c) 2016 Scott Shawcroft for Adafruit Industries +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. + +:func:`help` - Built-in method to provide helpful information +============================================================== + +.. function:: help(object=None) + + Prints a help method about the given object. When ``object`` is none, + prints general port information. |
