duburcqa / jiminy

Jiminy: a fast and portable Python/C++ simulator of poly-articulated robots with OpenAI Gym interface for reinforcement learning
https://duburcqa.github.io/jiminy
MIT License
223 stars 26 forks source link

[docs] Undocumented API #37

Open duburcqa opened 4 years ago

duburcqa commented 4 years ago

Python native code is properly documented, but it is not the case for the C++ API and the Python bindings (which are using the same documentation in most cases). It is really important to fix this, at least for methods and classes that the user is supposed to use in practice.

duburcqa commented 4 years ago

Also, add a wiki page about the physics, especially about the contact model.