Skip to content

Commit

Permalink
doc: Add missing docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
stephane-caron committed Oct 28, 2024
1 parent 147e0dd commit ce12eb8
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion pink/tasks/rolling_task.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,23 @@ def __init__(
gain: float = 1.0,
lm_damping: float = 0.0,
):
r"""Define a new rolling task.
Args:
hub_frame: Name of a frame attached to the hub of the wheel in the
robot model.
floor_frame: Name of the inertial frame whose xy-plane defines the
contact surface the wheel is rolling onto.
wheel_radius: Radius of the wheel, i.e. distance in meters from the
hub to the nearest point on the rim.
cost: scalar or 3D cost vector,
in :math:`[\mathrm{cost}] / [\mathrm{m}]`.
lm_damping: Levenberg-Marquardt damping (see class attributes). The
default value is conservatively low.
gain: Task gain :math:`\alpha \in [0, 1]` for additional low-pass
filtering. Defaults to 1.0 (no filtering) for dead-beat
control.
"""
super().__init__(
cost=cost,
gain=gain,
Expand All @@ -62,7 +79,7 @@ def __init__(
def compute_error(self, configuration: Configuration) -> np.ndarray:
r"""Compute the rolling task error.
The error is a vector :math:`{}_R e(q)` of the rim frame :math:`R`:
The error is a 3D vector :math:`{}_R e(q)` of the rim frame :math:`R`:
.. math::
Expand Down

0 comments on commit ce12eb8

Please sign in to comment.