Skip to content

Add descriptive help() function #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
tdicola opened this issue Oct 24, 2016 · 3 comments
Closed

Add descriptive help() function #35

tdicola opened this issue Oct 24, 2016 · 3 comments
Labels
enhancement
Milestone
Beta

Comments

@tdicola
Copy link

tdicola commented Oct 24, 2016 •
edited
Loading

Currently help() is unimplemented, but we should add a descriptive block of text that explains at least the micropython firmware version. Ideally it would have something with instructions on getting started, like with the esp8266 and microbit ports, would be nice to add too. See esp8266 help implementation: https://github.com/adafruit/micropython/blob/master/esp8266/help.c
@tannewt tannewt modified the milestone: Beta Nov 30, 2016
@tannewt
Copy link
Member

tannewt commented Dec 8, 2016

What should we have the help() provide? Ideally it'd be short because it will be stored in flash memory.

@tannewt
Copy link
Member

tannewt commented Dec 9, 2016

Add a link to adafruit.com/micropython and autogenerate lists of available modules and their members.

@tannewt
Copy link
Member

tannewt commented Dec 20, 2016

Fixed in 427d33c. Example:

>>> help()
Welcome to Adafruit MicroPython v1.8.6-183-ge8db23d-dirty!

Please visit learn.adafruit.com/category/micropython for project guides.

Built in modules:
        __main__
        builtins
        micropython
        array
        ucollections
        ustruct
        math
        sys
        gc
        urandom
        framebuf
        microcontroller
        nativeio
        board
        uos
        time
        neopixel_write
        samd
        bitbangio
>>>

@tannewt tannewt closed this as completed Dec 20, 2016
dhalbert pushed a commit that referenced this issue Jan 5, 2021
@DavePutz
Merge pull request #35 from adafruit/main
3d5c77c 
Update from adafruit/main
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
Beta
Development

No branches or pull requests
2 participants
@tannewt @tdicola