From 6a3bb5d3207ea5329ab28a728e773d1f85580831 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Tue, 14 Jan 2020 20:51:43 +0100 Subject: [PATCH] doc/signaltypes: add acceleration This was added but there was no description yet. --- doc/api/signaltypes.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/api/signaltypes.rst b/doc/api/signaltypes.rst index 0308c81..078869f 100644 --- a/doc/api/signaltypes.rst +++ b/doc/api/signaltypes.rst @@ -113,7 +113,13 @@ For example, the speed of a robotic vehicle is expressed in mm/s. linear acceleration: mm/s/s -------------------------------- -TODO +Linear acceleration describes how fast the speed changes. This is expressed as +the change of the millimeters per second, during one second (deg/s/s). +This is also commonly written as :math:`mm/s^2`. + +For example, you can adjust the acceleration setting of a +:meth:`DriveBase <.robotics.DriveBase.set_drive_settings>` to change how +smoothly or how quickly it reaches the constant speed set point. .. _acceleration: