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

DriveBase doc suggestions #698

Closed
5 tasks done
dlech opened this issue Aug 5, 2022 · 2 comments
Closed
5 tasks done

DriveBase doc suggestions #698

dlech opened this issue Aug 5, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@dlech
Copy link
Member

dlech commented Aug 5, 2022

Describe the issue
What is wrong or unclear?

Suggested improvement
How can we fix it or make it clearer?

  • DriveBase class initializer: mention that wheel diameter is often printed on the side of the LEGO tire (if it says A mm x B mm, which is diameter?) and pin holes in beams are approx 8mm center-to-center in case you don't have a ruler handy, you can use that to estimate.
  • The intializer API doc should also link to the "Measuring and validating the robot dimensions" section, otherwise it is easy to miss.
  • Methods that don't have a speed parameter should mention the settings() method as the way to set the speed.
  • The settings() method should mention the default values.
  • Methods should document possible exceptions. For example, you get a ValueError if the angle in turn() is too large, but what is the largest allowable angle?
@dlech dlech added the documentation Improvements or additions to documentation label Aug 5, 2022
@laurensvalk
Copy link
Member

laurensvalk commented Aug 5, 2022

  • Explain that you can change the default turning direction by reversing the left and right motor arguments.
  • Consider allowing sub-millimeter (floating point) dimensions. The low-level code implicitly supports this already anyway.
  • Add code examples.

@laurensvalk
Copy link
Member

Fixed and/or deferred to separate issues as needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants