mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-11 17:14:41 +00:00
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.
This commit is contained in:
@@ -25,6 +25,9 @@ the settings.
|
||||
.. autoclass:: pybricks._common.Control
|
||||
:no-members:
|
||||
|
||||
.. autoattribute:: pybricks._common.Control.scale
|
||||
:annotation:
|
||||
|
||||
.. rubric:: Status
|
||||
|
||||
.. automethod:: pybricks._common.Control.done
|
||||
|
||||
@@ -90,13 +90,13 @@ class DCMotor:
|
||||
|
||||
|
||||
class Control:
|
||||
"""Class to interact with PID controller and settings.
|
||||
"""Class to interact with PID controller and settings."""
|
||||
|
||||
.. data:: scale
|
||||
|
||||
Scaling factor between the controlled integer variable
|
||||
and the physical output. For example, for a single
|
||||
motor this is the number of encoder pulses per degree of rotation.
|
||||
scale = 1.0
|
||||
"""
|
||||
Scaling factor between the controlled integer variable
|
||||
and the physical output. For example, for a single
|
||||
motor this is the number of encoder pulses per degree of rotation.
|
||||
"""
|
||||
|
||||
def limits(self, speed, acceleration, duty, torque):
|
||||
|
||||
Reference in New Issue
Block a user