Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity
900 Commits 10 Branches 125 Tags
dd2e6e8603d39c668b22e5cb25e1ea7ab07fa21f
Commit Graph
45 Commits
Author SHA1 Message Date
Laurens Valk a0f4818e26 ubuiltins.int: Document it. 2021-08-06 14:59:45 +02:00
Laurens Valk af23c10566 ubuiltins.float: Document it. 
Override typed docstrings in order to hide types like SupportsFloat.
 2021-08-06 14:58:19 +02:00
Laurens Valk d7096dad80 ubuiltins.complex: Document it. 
Override typed docstrings in order to hide types like SupportsFloat and SupportsComplex.

Avoid use of ``real`` and ``imag``, since both ``a`` and ``b`` can be
either.

Also reduce number of overloads by letting ``b`` default to 0, which is true in practice.

See also https://github.com/pybricks/pybricks-api/issues/84
 2021-08-06 14:25:00 +02:00
Laurens Valk d86b5584fb ubuiltins: Type enumerate as a class. 
This reverts commit a0ea0d8ca0 because of https://github.com/pybricks/pybricks-api/issues/72
 2021-08-06 09:51:52 +02:00
Laurens Valk 1c01e981e0 usys: Clean up. 
Add requirements, drop autodoc, and add a few cross references.
 2021-08-05 16:13:50 +02:00
Laurens Valk 786770cff2 ubuiltins.bool: Use arguments. 
https://github.com/pybricks/pybricks-api/issues/82
 2021-08-05 12:49:44 +02:00
Laurens Valk 572b573d2f ubuiltins: Fix _type typos. 
This was accidentally introduced via https://github.com/pybricks/pybricks-api/issues/71 by replacing too many things automatically.
 2021-08-05 12:33:00 +02:00
Laurens Valk 15bd870140 ubuiltins: Use argument layout. 
https://github.com/pybricks/pybricks-api/issues/82
 2021-08-05 12:32:56 +02:00
Laurens Valk b101d1992d ubuiltins.print: Use English. 2021-08-05 12:32:51 +02:00
Laurens Valk b013204f88 ubuiltins.input: Say what it does. 
The docstring said something about an argument, but not what this function is for.
 2021-08-05 12:32:47 +02:00
Laurens Valk 0ecf536cda ubuiltins: Add compatibility everywhere. 
This lets us sort everything by category or alphabetically without having to make special categories for Move Hub.
 2021-08-05 12:32:37 +02:00
Laurens Valk b02895e5fc ubuiltins: Use raw strings for inline math. 
This resolves the following warnings:
./src/ubuiltins/__init__.py:143:31: W605 invalid escape sequence '\l'
./src/ubuiltins/__init__.py:143:38: W605 invalid escape sequence '\l'
./src/ubuiltins/__init__.py:174:31: W605 invalid escape sequence '\l'
./src/ubuiltins/__init__.py:174:38: W605 invalid escape sequence '\l'
 2021-08-05 12:32:21 +02:00
Laurens Valk 486ac60ea0 ubuiltins.bool: Clarify docs. 
Avoid double and triple negatives.
 2021-08-05 12:32:17 +02:00
Laurens Valk a3b6507a15 ubuiltins.bytes: Clarify docs. 2021-08-05 12:32:14 +02:00
Laurens Valk 75bc15f071 ubuiltins: Add bytearray. 2021-08-05 12:32:03 +02:00
Laurens Valk 0b9280a8df uerrno: Display on separate page. 
Fixes https://github.com/pybricks/pybricks-api/issues/78
 2021-08-02 11:01:20 +02:00
David Lechner 677656f669 pybricks.robotics.DriveBase: Fix arg name in type hints. 
This fixes the `speed` arg name in the `DriveBase.drive()` method in the type hint file. Fixes #76.
 2021-07-30 15:27:09 -05:00
Laurens Valk a8ab8b2314 pybricks.pupdevices.Motor: Add reset_angle kwarg. 
Documents https://github.com/pybricks/support/issues/389
 2021-07-28 16:07:53 +02:00
Laurens Valk 8463206f8e pybricks.pupdevices.Remote: Add name(). 
https://github.com/pybricks/support/issues/404
 2021-07-28 13:41:00 +02:00
Laurens Valk 78bd21b197 pybricks.common.Control: Drop feed_forward. 
The implementation no longer includes this, so it is removed from the docs as well.

Fixes https://github.com/pybricks/pybricks-api/issues/74
 2021-07-23 15:35:13 +02:00
Laurens Valk 24bba6d24c pybricks.pupdevices.Motor: Document control here. 
Based on user feedback, we learned that the control attribute is used more frequently than anticipated. Therefore it makes sense to document it here, just like we do with instances of pybricks.common classes in hubs.

This makes it a bit easier to find and see how it is used, along with some of the existing examples.
 2021-07-23 15:33:18 +02:00
Laurens Valk 0edddbb0c2 pybricks.common.Control: Fix scale doc. 
Document it as an attribute instead of in the main docstring. This way we can choose where it shows up in the docs.
 2021-07-23 14:51:21 +02:00
Laurens Valk 923e8caf84 ubuiltins: Organize exceptions. 2021-07-21 11:12:51 +02:00
Laurens Valk e8d47ffca1 uerrno: Document alongside OSError. 
These are meant to be used together, so document them in the same place along with a practical example.
 2021-07-19 15:03:10 +02:00
Laurens Valk 2c32d093d0 ubuiltins.bytes: Clarify range up to 255. 
Be consistent and use <= for both. A bit more intuitive because the number 256 cannot be used in bytes objects.
 2021-07-16 16:12:43 +02:00
Laurens Valk ba6d7ac3f5 ubuiltins: Fix unwanted ubuiltins prefix. 
Fixes https://github.com/pybricks/pybricks-api/issues/71.
 2021-07-16 16:07:55 +02:00
Laurens Valk a0ea0d8ca0 ubuiltins: Document enumerate as a function. 
Though it is technically its own type in MicroPython, this change follows the CPython documentation. Essentially this just drops the class prefix and leaves everything else unchanged.

This makes more sense when organizing this module by classes and functions. It's also a bit more logical since the equivalent example we provoide is a function definition, not a class definition.
 2021-07-16 16:07:55 +02:00
Laurens Valk cd7d5be748 micropython.stack_info: Clean up docstring. 
Reword to say how it useful, not how it is not useful.

Also fix return type.
 2021-07-14 15:36:18 +02:00
Laurens Valk 97e368312e micropython.qstr_info: Clean up docstring. 
Say the same with less words. Also add one line from elsewhere in the MicroPython docs to explain what this is about.
 2021-07-14 15:32:28 +02:00
Laurens Valk 28af77fcfc micropython.mem_info: Clean up docstring. 
Say the same with less words.
 2021-07-14 15:31:41 +02:00
Laurens Valk 3ed6e2dd7d micropython.opt_level: Clarify docstring. 
Just list what each level does instead of a complicated if-then bullet list. It's still shorter anyway.

Also add a note that this only applies to REPL code in case of Pybricks.
 2021-07-14 15:13:26 +02:00
Laurens Valk 4c00c3209b micropython.const: Improve docstring, add example. 
This merges the useful information from two different places:
- The original docstring for const.
- Writing MicroPython code for constrained devices.

Also reduce type to just int, because only ints are supported.
 2021-07-14 14:48:59 +02:00
Laurens Valk c656eae2f3 micropython: Drop TConst type. 
TConst does not exist, so adding it makes it a bit harder to read than needed. The const() "function" will take int or float, and the return value can be used as such, even if it is optimized out. This is described in the docstring, so we can leave out the additional type.

Also adds autofunctions in place of one auto module so we can move things around as needed. Also fix cross links with usys to get the build to pass before we update that module.
 2021-07-14 14:13:18 +02:00
Laurens Valk 1fab46e67f doc/main/index: Clean up menu and builtins. 
There is no ubuiltins module, so we shouldn't mention it.

Also reduce size of other module titles so they fit on one line in the
menu. This makes it easier to read and get an overview.
 2021-07-14 11:39:20 +02:00
Laurens Valk 727ec3fe46 umath: Redo module docs. 
This reworks the documentation for the umath module, as done previously as per https://github.com/pybricks/pybricks-api/pull/64 and https://github.com/pybricks/pybricks-api/issues/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.
 2021-07-14 11:22:04 +02:00
Laurens Valk 9944cf3adf pybricks.common.System: Add name() getter. 2021-07-14 09:43:20 +02:00
David Lechner 286079fe68 ubuiltins: add stubs and docs for ubuiltins module 
Issue: https://github.com/pybricks/support/issues/236
 2021-07-14 09:41:30 +02:00
David Lechner d492b04402 umath: add stubs and docs for umath module 
Issue: https://github.com/pybricks/support/issues/236
 2021-07-14 09:41:30 +02:00
David Lechner 818409f675 usys: add stubs and docs for usys module 
Issue: https://github.com/pybricks/support/issues/236
 2021-07-14 09:41:30 +02:00
David Lechner 9dd131142e uselect: add stubs and docs for uselect module 
Issue: https://github.com/pybricks/support/issues/236
 2021-07-14 09:41:30 +02:00
David Lechner f828d11f40 urandom: add stubs and docs for urandom module 
Issue: https://github.com/pybricks/support/issues/236
 2021-07-14 09:41:30 +02:00
David Lechner 532639b820 uio: add stubs and docs for uio module 
Issue: https://github.com/pybricks/support/issues/236
 2021-07-14 09:41:30 +02:00
David Lechner 0865a58632 uerrno: add uerrno module stubs and docs 
Issue: https://github.com/pybricks/support/issues/236
 2021-07-14 09:41:30 +02:00
David Lechner 0eb0e160e9 micropython: Add stubs and docs for micropython module 
Issue: https://github.com/pybricks/support/issues/236
 2021-07-14 09:41:30 +02:00
David Lechner 7126431f9f pybricks: move into src/ directory 
Moving the pybricks package into a src/ directory so that we can add
additional packages without polluting the top-level directory.
 2021-07-14 09:41:30 +02:00