Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] Undocumented API #37

Open
duburcqa opened this issue Mar 2, 2020 · 1 comment
Open

[docs] Undocumented API #37

duburcqa opened this issue Mar 2, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation P2 Low priority issue
Projects
Jiminy 2.0

Comments

@duburcqa
Copy link
Owner

duburcqa commented Mar 2, 2020 •
edited
Loading

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 duburcqa added the documentation Improvements or additions to documentation label Mar 2, 2020
@duburcqa
Copy link
Owner Author

duburcqa commented Mar 2, 2020

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

@duburcqa duburcqa removed their assignment Mar 12, 2020
@duburcqa duburcqa changed the title Undocumented API [docs] Undocumented API Oct 25, 2020
@duburcqa duburcqa added this to To do in Jiminy 1.8 Nov 25, 2020
@duburcqa duburcqa removed this from To do in Jiminy 1.8 Mar 21, 2021
@duburcqa duburcqa added this to To do in Jiminy 2.0 via automation Mar 21, 2021
@duburcqa duburcqa added the P1 Mid priority issue label Nov 12, 2021
@duburcqa duburcqa added P2 Low priority issue and removed P1 Mid priority issue labels Apr 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation P2 Low priority issue
Projects
Jiminy 2.0
Status: To do
Jiminy 2.0
To do
Milestone
No milestone
Development

No branches or pull requests
2 participants
@matthieuvigne @duburcqa