Skip to content
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

Document included MicroPython modules #63

Closed
11 tasks done
laurensvalk opened this issue Jul 7, 2021 · 5 comments
Closed
11 tasks done

Document included MicroPython modules #63

laurensvalk opened this issue Jul 7, 2021 · 5 comments
Assignees
@laurensvalk
Labels
documentation Improvements or additions to documentation

Comments

@laurensvalk
Copy link
Member

laurensvalk commented Jul 7, 2021 •
edited
Loading

The differences with upstream MicroPython, LEGO MicroPython, and CPython are too subtle, so we can't really get away with just linking to those.

Instead, we should just explicity document all functions that come with the Pybricks firmware. We can still link to upstream sources for each method, but only when doing so provides useful additional information (rather than confuse things).

  • builtins
  • umath
  • uio
  • ustruct
  • micropython EDIT: Need to write args as bullet point consistent with rest.
  • usys
  • uselect
  • ujson
  • urandom
  • uerrno
  • Clean up Exceptions page with OSError section
@laurensvalk
Copy link
Member Author

Also include a page for all builtins, like round, or pow.

@laurensvalk
Copy link
Member Author

First draft of umath can be previewed here for discussion.

@dlech
Copy link
Member

dlech commented Jul 7, 2021

I was actually working on this yesterday. I have all of the modules done, including builtins. Although I just copied from existing documentation and didn't fix it up that much.

@dlech dlech mentioned this issue Jul 7, 2021
Merged
laurensvalk added a commit that referenced this issue Jul 14, 2021
@laurensvalk
umath: Redo module docs.
37adc6e 
This reworks the documentation for the umath module, as done previously as per #64 and #63

The presentation and docstrings are inspired by the Python 3 math module documentation instead of the MicroPython math module documentation. Functions are grouped roughly by use case.
laurensvalk added a commit that referenced this issue Jul 14, 2021
@laurensvalk
umath: Redo module docs.
727ec3f 
This reworks the documentation for the umath module, as done previously as per #64 and #63

The presentation and docstrings are inspired by the Python 3 math module documentation instead of the MicroPython math module documentation. Functions are grouped roughly by use case.
@laurensvalk laurensvalk mentioned this issue Jul 28, 2021
Closed
@laurensvalk laurensvalk mentioned this issue Jul 4, 2022
Closed
This was referenced Nov 28, 2022
Closed
Closed
@laurensvalk
Copy link
Member Author

Builtins are done now.

@laurensvalk laurensvalk self-assigned this Nov 28, 2022
@dlech dlech added the documentation Improvements or additions to documentation label Nov 28, 2022
@laurensvalk
Copy link
Member Author

This is done 🎉.

A first pass, anyway. There are places to improve further, but this makes it presentable enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@laurensvalk laurensvalk

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dlech @laurensvalk