bbcmicrobit / bbcmicrobit/micropython

Missing modules in the docs

Open
#655 5 comments 0 reactions 0 assignees View on GitHub
docs good first issue
Dominant language
C
Stars
646
Forks
290
PR merge metrics
No merged PRs in 30d

Description

The following MicroPython modules are not referenced in the docs:

* array
- [Upstream docs](https://docs.micropython.org/en/latest/library/array.html)
* builtins
- [Upstream docs](https://docs.micropython.org/en/latest/library/builtins.html)
* ucollections
- [Upstream docs](https://docs.micropython.org/en/latest/library/ucollections.html)
* gc
- [Upstream docs](https://docs.micropython.org/en/latest/library/gc.html)
* math
- [Upstream docs](https://docs.micropython.org/en/latest/library/math.html)
* ustruct
- [Upstream docs](https://docs.micropython.org/en/latest/library/ustruct.html)
- Related issue: https://github.com/bbcmicrobit/micropython/issues/652
* sys
- [Upstream docs](https://docs.micropython.org/en/latest/library/sys.html)

We should either port the upstream docs (note that the module might only be partially enabled in the micro:bit port) or add an entry and link to the upstream docs.
Taking in consideration we have already ported `utime`, `micropython`, and `machine`, we should probably do the same for these.

PRs are welcomed and I'd be happy to walk through the process with anybody that might want to contribute to the project :)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.