Skip to content

Commit

Permalink
docs(app): improve stubs create help.
Browse files Browse the repository at this point in the history
Signed-off-by: Braden Mars <bradenmars@bradenmars.me>
  • Loading branch information
BradenM committed Apr 22, 2023
1 parent efa3263 commit 9738ac7
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions micropy/app/stubs.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,26 @@ def stubs_create(
Utilize Josverl's [micropython-stubber](https://github.com/josverl/micropython-stubber/)
to generate stubs from your own micropython-enabled device.
\n
**Create stubs with defaults**:\n
- `micropy stubs create /dev/ttyUSB0`
\n
**Specify additional modules**:\n
- `micropy stubs create -m custom_module -m other_module /dev/ttyUSB0`\n
- _Only given modules_: `micropy stubs create -m custom_module --no-module-defaults /dev/ttyUSB0`
\n
**Exclude additional modules**:\n
- `micropy stubs create -e custom_module -e other_module /dev/ttyUSB0`\n
- _Only exclude given modules_: `micropy stubs create -e custom_module --no-module-defaults /dev/ttyUSB0`
\n
**Create Stubs Variants**:\n
- **mem**: Optimized for low memory devices._\n
- **db**: Persist stub progress across reboots.\n
- **lvgl**: Additional support for LVGL devices.\n
"""
mp: MicroPy = ctx.ensure_object(MicroPy)
log = mp.log
Expand Down

0 comments on commit 9738ac7

Please sign in to comment.