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

[Doc] Document Drivebase updates #535

Closed
laurensvalk opened this issue Nov 18, 2021 · 5 comments
Closed

[Doc] Document Drivebase updates #535

laurensvalk opened this issue Nov 18, 2021 · 5 comments
Assignees
@laurensvalk
Labels
documentation Improvements or additions to documentation topic: motors Issues involving motors

Comments

@laurensvalk
Copy link
Member

Need to document:

  • curve() method.
  • busy() method.
  • wait and then arguments added.
@laurensvalk laurensvalk added documentation Improvements or additions to documentation topic: motors Issues involving motors labels Nov 18, 2021
@laurensvalk laurensvalk self-assigned this Nov 18, 2021
@laurensvalk
Copy link
Member Author

Also add a few examples. We have a few examples as tests already.

@laurensvalk
Copy link
Member Author

There's still a few bugs in these methods, so perhaps we should not document this for V3.1, or even disable them from the locals_dict in the Drive Base class.

@laurensvalk
Copy link
Member Author

There's still a few bugs in these methods, so perhaps we should not document this for V3.1, or even disable them from the locals_dict in the Drive Base class.

This is fixed on the motor branch. We can cherry-pick the small fixes for this release.

@laurensvalk
Copy link
Member Author

After some more thought (and time limitations), perhaps let's not document this feature for this release, so it's not officially released.

@laurensvalk
Copy link
Member Author

Done via pybricks/pybricks-api@30803fc.

Skipping finalization of DriveBase.busy so we can make it consistent with other Motor and robotics classes layer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@laurensvalk laurensvalk

Labels
documentation Improvements or additions to documentation topic: motors Issues involving motors
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@laurensvalk