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

Dev/python cleanup #1

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Dev/python cleanup #1

wants to merge 10 commits into from

Conversation

Notgnoshi
Copy link

Clean up module.

Add documentation and follow more "Pythonic" standards.

Notgnoshi added 10 commits July 9, 2018 17:44
In Python, it's normal to access attributes directly. If it every
becomes necessary to wrap an attribute in a getter/setter, there are
@decorators that will maintain backwards compatability.
The Arduino interface needs to be documented better, or at least
mentioned. but I don't have enough information to do so myself.

The documentation added in this commit also makes a few assumptions on
the ranges of inputs, and their meaning. These should not be
assumptions.
Simplify the drive_forward and drive_backward implementations. Note that
the send_cmd() method already maps numbers to a short integer, so we
don't need to do so ourselves. (Verify?)

Also, the locomotion methods should make a note of the type of
locomotion they implement.
Major:
* align constants even though our beloved PEP8 forbids it.
* Add optional timeout to drive_*_wheel commands so that they act the
  same as the drive_forward and drive_backward commands.

Minor:
* Add comments, examples, solve world hunger, etc., etc.
@Notgnoshi Notgnoshi requested review from RemBullis and krJean July 10, 2018 01:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant