Laurens Valk
32ab928aa8
doc/ev3devices/UltrasonicSensor: add freeze note
...
Simplify the text for silent mode, and add a note to say what to do if it stops working when the UART gets confused.
2020-04-07 13:41:04 +02:00
David Lechner
87c2b6857f
api: Use leading _ to hide internals in intellisense
...
Intellisense in VS Code (both jedi and ms python language server) picks
up all imported names and suggests them with equal priority for
code completion. By adding a leading underscore, intellisense lists
these with a lower priority, so they don't get in the way.
Also rename from builtins to _common while we are touching this to
better reflect the intention of the module (it contains types shared
by multiple modules, not builtin types like int).
2020-03-25 20:24:32 +01:00
Laurens Valk
ada50328bb
doc/pupdevices/Motor: fix reset_angle
...
The note about absolute angle support had accidentally ended up in the GyroSensor. It applies only to pupdevices.Motor.
2020-03-24 16:25:06 +01:00
David Lechner
166ce2109f
doc: Use verbs ending in s for functions/methods
...
The documentation currently has a mix of with and without the `s`.
Adding an `s` is consistent with most API documentation in general,
especially more modern documentation.
2020-03-24 12:11:53 +01:00
Laurens Valk
661de5f0fe
doc/*devices: improve rgb() docstring
2020-03-20 10:42:52 +01:00
Laurens Valk
9dd1f45ccd
doc: drop default argument in docstring
...
This is visible in the function definition, so no need to repeat it.
2020-03-15 20:35:36 +01:00
David Lechner
6ed6ec0378
api: remove empty () on class declarations
...
Python allows this syntax and some even consider it good style.
2020-03-12 12:46:09 -05:00
Laurens Valk
066983a5e1
LICENSE: Update year and authors
...
Also add SPDX-License-Identifier: MIT to API source files for clarity.
2020-03-05 10:33:48 +01:00
Laurens Valk
c55556a598
config: ignore unused import
...
These are not used by classes in the docs, but they are used by Sphinx.
Also, this will be used to let autocomplete know that these modules contain a Motor class.
2020-01-28 18:03:18 +01:00
Laurens Valk
9a3d4f88b6
doc/ev3devices, pupdevices: drop catalog id
...
This will be replaced with a render of the device, included by the RST file, not the docstring.
2020-01-28 18:00:55 +01:00
Laurens Valk
e73945d9c5
doc/ev3devices, pupdevices: do not inherit Motor
...
Just import it. Otherwise, Sphinx does not pick up autoattribute docstrings.
2020-01-28 17:58:54 +01:00
Laurens Valk
46de4b73ca
doc/ev3devices: drop millimeters note
...
This is already shown as the return type, so this is a duplicate.
2020-01-14 19:38:59 +01:00
Laurens Valk
220ad471b8
api/ev3devices: remove duplicate AnalogSensor
...
This has previously been moved to the iodevices class
2020-01-13 13:30:08 +01:00
Laurens Valk
e244f28ddb
api/builtins: drop method string override
...
We had these because enums expanded to numeric values. Because we now have an alternate enum implementation, we don't need these strings anymore.
2020-01-13 12:19:59 +01:00
David Lechner
31a639f55b
doc/api/conf.py: enable nitpicky
...
This enables the sphinx doc nitpicky option to detect broken references.
Also fix all of the broken references.
2020-01-11 21:08:20 -06:00
Laurens Valk
63992c7ad0
doc/ev3devices/AnalogSensor: add passive/active methods
2019-11-11 15:29:39 +01:00
Laurens Valk
1be5beb54e
doc/ev3devices/AnalogSensor: update type check
...
We no longer have to tell people to reboot the brick after changing the port mode. This is all done automatically now.
2019-11-11 15:22:41 +01:00
Laurens Valk
f03970a77e
doc/motors: rename direction to positive_direction
...
While being longer, this reflects more accurately what this setting does.
2019-11-11 15:19:25 +01:00
Laurens Valk
f73e10b99b
api: add EV3 Analog Sensor
2019-11-04 16:58:30 +01:00
Laurens Valk
529f8fe31c
api: rename _common to builtins
...
Because this module describes devices that can be built into a hub or other device.
Since this design is now explicitly shown in
the docs as well, we don't need to hide this
module in the package.
2019-10-18 16:05:23 +02:00
Laurens Valk
be1d30c4c8
api/ev3devices: add InfraredSensor.keypad
2019-07-22 11:44:56 +02:00
Laurens Valk
12834ffc73
api: fix relative links due to package
2019-06-11 20:13:38 +02:00
Laurens Valk
28a5329bb6
api/doc: pybricks is a package
2019-06-05 12:47:24 +02:00
Laurens Valk
8d37450fac
api: flake8
2019-06-04 15:45:36 +02:00
Laurens Valk
3091489843
move API
2019-05-09 17:15:52 +02:00
Laurens Valk
David Lechner