doc/common: fix unit of acceleration

This commit is contained in:
Laurens Valk
2021-01-05 16:31:35 +01:00
parent f3f0532f74
commit 1f991302e5
2 changed files with 11 additions and 2 deletions
+9
View File
@@ -125,6 +125,15 @@ For example, you can adjust the acceleration setting of a
:class:`DriveBase <.robotics.DriveBase>` to change how
smoothly or how quickly it reaches the constant speed set point.
.. _linacceleration_m:
linear acceleration: m/s/s
--------------------------------
As above, but expressed in meters per second squared: :math:`m/s^2`.
This is a more practical unit for large values such as those given by an
accelerometer.
Approximate and relative units
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+2 -2
View File
@@ -725,7 +725,7 @@ class Accelerometer:
axis (Axis): Axis along which the acceleration is
measured.
Returns:
:ref:`linacceleration`. Returns the acceleration along the
:ref:`linacceleration_m`: Acceleration along the
specified axis. If you specify no axis, this returns a vector
of accelerations along all axes.
"""
@@ -811,7 +811,7 @@ class IMU(Accelerometer):
axis (Axis): Axis along which the angular velocity is
measured.
Returns:
:ref:`speed`. Returns the angular velocity along the
:ref:`speed`: Angular velocity along the
specified axis. If you specify no axis, this returns a vector
of accelerations along all axes.
"""