stack-of-tasks / pinocchio

A fast and flexible implementation of Rigid Body Dynamics algorithms and their analytical derivatives
http://stack-of-tasks.github.io/pinocchio/
BSD 2-Clause "Simplified" License
1.7k stars 366 forks source link

[doc] Improve documentation of getJointJacobian. #2193

Closed fabinsch closed 3 months ago

fabinsch commented 3 months ago

After several discussions about Jacobians and ReferenceFrames, and the nice improvement of the doc string #2190, I propose to fix and improve the docstring of getJointJacobian.

This doc string did not render properly due to some missing \f in front of $. While adding it, I tried to add further details about the calculated quantities and be verbose about their meaning.

For more rigorous mathematical details, we could also refer to A Mathematical Introduction to Robotic Manipulation by Murray, Li and Sastry (thanks for the pointer @stephane-caron).