mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 01:24:17 +00:00
pybricks.parameters. Document with full namespace.
This types them in full for the object index.
This commit is contained in:
@@ -10,6 +10,8 @@ Prime Hub / Inventor Hub
|
||||
|
||||
.. blockimg:: pybricks_variables_set_inventor_hub_option4
|
||||
|
||||
.. currentmodule:: pybricks.hubs
|
||||
|
||||
.. class:: InventorHub
|
||||
|
||||
This class is the same as the ``PrimeHub`` class, shown below. Both classes
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
Button
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. currentmodule:: pybricks.parameters
|
||||
|
||||
.. class:: Button
|
||||
|
||||
.. rubric:: Remote and hub buttons
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
Direction
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. currentmodule:: pybricks.parameters
|
||||
|
||||
.. class:: Direction
|
||||
|
||||
Rotational direction for positive speed or angle values.
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
Port
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. currentmodule:: pybricks.parameters
|
||||
|
||||
.. class:: Port
|
||||
|
||||
Input and output ports:
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
Side
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. currentmodule:: pybricks.parameters
|
||||
|
||||
.. class:: Side
|
||||
|
||||
Side of a hub or a sensor. These devices are
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
Stop
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. currentmodule:: pybricks.parameters
|
||||
|
||||
.. class:: Stop
|
||||
|
||||
Action after the motor stops.
|
||||
|
||||
@@ -291,5 +291,5 @@ though the *hub* accelerates backward.
|
||||
How to configure the ``top_side`` and ``front_side`` settings for three
|
||||
different robot designs. The same technique can be applied to other hubs
|
||||
and other creations, by noting which way the top and
|
||||
front :class:`Side <Side>` of the hub are pointing. The example
|
||||
front :class:`Side <pybricks.parameters.Side>` of the hub are pointing. The example
|
||||
on the left is the default configuration.
|
||||
|
||||
Reference in New Issue
Block a user