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 method exceptions #831

Open
laurensvalk opened this issue Dec 6, 2022 · 2 comments
Open

[Doc] Document method exceptions #831

laurensvalk opened this issue Dec 6, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation topic: motors Issues involving motors

Comments

@laurensvalk
Copy link
Member

Methods should document possible exceptions. For example, you get a ValueError if the angle in DriveBase.turn() is too large, but what is the largest allowable angle?

Originally posted by @dlech in #698
@laurensvalk laurensvalk added documentation Improvements or additions to documentation topic: motors Issues involving motors labels Dec 6, 2022
@laurensvalk laurensvalk mentioned this issue Dec 6, 2022
Closed
@laurensvalk
Copy link
Member Author

More generally, we need to document the allowed inputs, and raise the appropriate errors when out of bounds.

@dlech
Copy link
Member

dlech commented Apr 28, 2023

Similar request in #150

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 topic: motors Issues involving motors
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dlech @laurensvalk