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.

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

Documentation issues #85

Closed
johann-petrak opened this issue Nov 11, 2022 · 1 comment
Closed

Documentation issues #85

johann-petrak opened this issue Nov 11, 2022 · 1 comment
Labels
documentation Documentation update invalid This doesn't seem right question Further information is requested
Milestone

Comments

@johann-petrak
Copy link

When browsing the wiki and API documentation:

  • The links from the wiki to the API documentation are broken: https://softbankrobotics-research.github.io/qibullet/api/ gives a 404
  • the API docs are apparently: https://softbankrobotics-research.github.io/qibullet/annotated.html
  • The documentation for the setAngles method for RobotVirtual says the values should be between 0 and 1, but the documentation for the setAngles method for PepperVirtual says it should be a percentage (which would mean between 0.0 and 100.0). The corresponding naoqi API requires a value between 0 and 1 there though so what is it for the PepperVirtual class?
  • The documentation does not say anything about error handling or debugging
@mbusy mbusy added invalid This doesn't seem right question Further information is requested documentation Documentation update labels Dec 24, 2022
@mbusy
Copy link
Member

mbusy commented Dec 24, 2022

  • The link towards the documentation has been updated in the wiki.
  • Regarding the documentation for the setAngles method, both methods specify a percentage, the only difference is that the base method defined in RobotVirtual specifies that the value is expected to be between 0 and 1. The method defined in PepperVirtual also expects percentages, so the same kind of value (for instance 50%, or 0.5, will be comprised between 0 and 1 😁) If it wasn't explicit enough, now it will be, the value range has been specified in the various setAngles methods.
  • There is no plan to add anything about error handling and debugging in the docs. But if you want to add that, PRs are welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation update invalid This doesn't seem right question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants