Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-07-28 04:07:46 +00:00
Code Issues Releases Activity
1,139 Commits 10 Branches 124 Tags
96a3c04836078a776ecb0149507365f9e1bc580d
Commit Graph
1139 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Laurens Valk 96a3c04836 doc/main/index: Drop links from menu. 
Table of contents can't be hidden based on tags, so we just remove them.

Instead, add a note in the body of the standalone version.

Fixes: https://github.com/pybricks/support/issues/839
 2022-12-08 09:47:04 +01:00
Laurens Valk 72f5cb6827 micropython: Use separate keys for CTRL + C. 
Since each :kbd: key is rendered as a button, it is more intuitive to
render them separately. (There is no CTRL-C button.)

Fixes https://github.com/pybricks/pybricks-api/issues/125
 2022-12-08 09:32:08 +01:00
David Lechner e939c14fee docs/main/{prime,essential}hub: Remove beta note. 
We are close to final release, so these are no longer considered beta.
 2022-12-07 16:31:19 -06:00
David Lechnerandlaurensvalk 3418c8320c doc/common/css/ide: improve styling of field list 
The default style of using a grid with two columns wastes space when
displayed in a narrow pane, like in Pybricks Code. Using flex with
column direction makes it flow from top to bottom.

Fixes: https://github.com/pybricks/support/issues/832
 2022-12-07 20:21:47 +01:00
Laurens Valk 4da4ce8f7c pybricks.robotics.DriveBase: Add clarifying comments. 
Fixes https://github.com/pybricks/support/issues/698
 2022-12-06 16:38:31 +01:00
Laurens Valk 6640fba104 npm/jedi: v1.5.0 @pybricks/jedi/v1.5.0 2022-12-02 15:20:08 +01:00
Laurens Valk ecbfbcfccc jedi/pyproject: v1.5.0 pybricks_jedi/v1.5.0 2022-12-02 15:18:10 +01:00
Laurens Valk eff6eaa253 jedi: Add ustruct, json modules. 2022-12-02 15:17:55 +01:00
Laurens Valk f7984a4816 @pybricks/ide-docs v2.5.0 @pybricks/ide-docs/v2.5.0 2022-12-02 14:37:50 +01:00
Laurens Valk eac3535d92 npm/jedi: v1.4.0 
Update pybricks_jedi Python package to v1.4.0.
@pybricks/jedi/v1.4.0 		2022-12-02 14:36:21 +01:00
Laurens Valk 7fd508cc84 jedi/pyproject: v1.4.0 pybricks_jedi/v1.4.0 2022-12-02 14:34:47 +01:00
Laurens Valk 3a12de4766 jedi: update pybricks package to v3.2.0b6 2022-12-02 14:33:16 +01:00
Laurens Valk 5535da5b38 pyproject: v3.2.0b6 
Update version for pybricks Python package release.
v3.2.0b6 		2022-12-02 14:29:33 +01:00
Laurens Valk ab4d4cc848 pybricks.pupdevices.Motor: Add versionchanged. 
Document moving stalled, load, done.
 2022-12-02 14:20:51 +01:00
Laurens Valk 82340c3eec jedi: Update tests for stalled, done. 2022-12-02 12:43:24 +01:00
Laurens Valk 14a4fc0d74 pybricks.robotics: Document behavior on shared resources. 
Fixes https://github.com/pybricks/pybricks-api/issues/105.
 2022-12-02 12:43:24 +01:00
Laurens Valk 99d5210313 pybricks.robotics.DriveBase: Add stalled, done. 2022-12-02 12:43:24 +01:00
Laurens Valk e6d2ce7f62 examples: Update use of done(). 2022-12-02 12:43:24 +01:00
Laurens Valk c3802d38c2 pybricks.ev3devices: Keep motor class in sync. 
Let's make sure we keep EV3 pages building.
 2022-12-02 12:43:24 +01:00
Laurens Valk ac23a9bb59 pybricks.common.Motor: Document compatibility. 
Control methods are not available on Move Hub.

Fixes: https://github.com/pybricks/pybricks-api/issues/106
 2022-12-02 12:15:25 +01:00
Laurens Valk 631cf31a07 pybricks.common.Motor: Document when settings take effect. 
This updates how and when settings take effect. In this release, you can
change them even while the motor is moving. Some settings do not
take effect right away, as now indicated in the relevant methods.

See also https://github.com/pybricks/pybricks-api/issues/105
 2022-12-02 12:10:31 +01:00
Laurens Valk 115ae0d856 pybricks.common.Motor: Add done, stalled, load. 
These used to be implemented as part of the Control object,
but now they are available directly on the motor.

This way they:
- Also give useful values when control is passive, via dc().
- Can be supported on Move Hub
- Give useful values for drive bases (see next commits).

Fixes https://github.com/pybricks/pybricks-api/issues/115
 2022-12-02 12:02:22 +01:00
Laurens Valk eec6d2ff85 pybricks.parameters: Delete TODO on hue. 
This should be an issue, not a mark in the released docs.
 2022-12-01 16:59:54 +01:00
Laurens Valk 4d360d2b01 pybricks.parameters: Reduce floating warning to note. 
This is a good case of a box. But nothing blows up if you try it, so a note suffices.
 2022-12-01 16:59:08 +01:00
Laurens Valk 52cb0fe81e ubuiltins: Fix missing types on print args. 2022-12-01 16:49:45 +01:00
Laurens Valk 961cebe48b ustruct: Document modules. 2022-12-01 16:48:20 +01:00
Laurens Valk 87c2802b17 jedi/tests: Fix order for Poll/poll. 
Poll needs to come first for correct typing of poll.
 2022-12-01 15:06:31 +01:00
Laurens Valk 3c0aaea207 usys: Add version info. 
Fixes https://github.com/pybricks/pybricks-api/issues/119
 2022-12-01 15:02:25 +01:00
Laurens Valk 553490874b usys: Add examples. 2022-12-01 14:21:12 +01:00
Laurens Valk 31d3872405 uselect: Rewrite the docs. 2022-12-01 14:11:41 +01:00
Laurens Valk 6f55e90365 urandom: Update remaining functions. 
Also modify the categories given implicitly in the Python
file and make them explicit in the docs.

Most users are going to want to use `randint` or `random`, so
that basic category comes first.
 2022-12-01 11:19:42 +01:00
Laurens Valk 76f129f6d1 urandom: Update docstring style. 
Also remove the tip boxes. The entire documentation consist of tips of
one form or another.

Boxes should only be used when necessary such as safety reasons (warnings)
or to prevent costly/time consuming mistakes (notes/tips).
 2022-12-01 10:48:06 +01:00
Laurens Valk d4d7971a56 pybricks.hubs: Update storage documentation. 
This moves the per-hub storage size to the respective page.

This also clarifies that data is cleared when updating Powered Up hubs.

Also flip docstring signatures around to work around https://github.com/pybricks/pybricks-api/issues/117
 2022-12-01 10:17:41 +01:00
Laurens Valk 64b0489a73 urandom: Move example to Move Hub. 
Move it do a dedicated example instead of hardcoding it in the module docstring.

Also update changelog for missing previous changes while we are at it.
 2022-12-01 09:55:40 +01:00
Laurens Valk 87ed7353b4 ujson, urandom, uselect: Document compatibility. 2022-11-29 20:32:53 +01:00
Laurens Valk aca23197a1 micropython: Document compatibility. 
Fixes https://github.com/pybricks/pybricks-api/issues/118
 2022-11-29 20:32:09 +01:00
Laurens Valk 69a2a2b8a2 uio: Don't use alloc_size. 
Follows the upstream MicroPython guidance.
 2022-11-29 20:30:08 +01:00
Laurens Valk f5d9a4f1c6 uio: Document getvalue. 2022-11-29 20:28:08 +01:00
Laurens Valk 71ce165a46 uio: Update style. 
Also fix compatibility information.
 2022-11-29 20:23:23 +01:00
Laurens Valk 56ab509630 ujson: Document module. 2022-11-29 16:00:00 +01:00
Laurens Valk 9608a16d95 micropython: Update style. 
This makes it consistent with our other modules.

Follows https://github.com/pybricks/pybricks-api/issues/82
 2022-11-29 15:59:32 +01:00
Laurens Valk 9b314777e0 micropython: Document heap_lock, heap_unlock. 
Fixes https://github.com/pybricks/pybricks-api/issues/116
 2022-11-29 13:51:34 +01:00
Laurens Valk 1ae0a9005f pybricks.parameters.Stop: Document NONE. 
Fixes https://github.com/pybricks/pybricks-api/issues/104
 2022-11-28 17:10:53 +01:00
Laurens Valk 1d5956a58a pybricks.parameters.Stop: Document COAST_SMART. 
See https://github.com/pybricks/pybricks-api/issues/104
 2022-11-28 17:01:06 +01:00
Laurens Valk 73c4a449ab ubuiltins: Document super. 2022-11-28 16:17:36 +01:00
Laurens Valk aeeed159d7 ubuiltins: Document isinstance, issubclass. 2022-11-28 16:13:59 +01:00
Laurens Valk 104fd7d70f ubuiltins: Document setattr. 2022-11-28 16:07:10 +01:00
Laurens Valk e9e5f48756 ubuiltins: Document getattr, hasattr. 2022-11-28 16:04:25 +01:00
Laurens Valk 8260d71cd7 ubuiltins: Document dir. 2022-11-28 15:51:44 +01:00
Laurens Valk ac43f8a29f ubuiltins: Document callable. 2022-11-28 15:45:30 +01:00