circuitpython/shared-bindings/help.c

/*
 * 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.
 */

#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.
//|

// TODO(tannewt): Figure out how to translate this. Its weird because its a global string.

const char circuitpython_help_text[] =
    "Welcome to Adafruit CircuitPython " MICROPY_GIT_TAG "!\r\n"
    "\r\n"
    "Please visit learn.adafruit.com/category/circuitpython for project guides.\r\n"
    "\r\n"
    "To list built-in modules please do `help(\"modules\")`.\r\n";