Edited the mecanum drive example code to be more frc-docs like. #50
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
auscompgeek
reviewed
Sep 3, 2022
mecanum-drive/robot.py
Outdated
|
|
||
| def teleopInit(self): | ||
| self.drive.setSafetyEnabled(True) | ||
| self.m_stick = Joystick(self.kJoystickChannel) |
There was a problem hiding this comment.
Our examples drop the m_ prefix as it's already clear that these are member variables by the mandatory use of self. We settled on this in the frc-docs PR too.
mecanum-drive/robot.py
Outdated
| @@ -6,52 +6,38 @@ | |||
|
|
|||
| import wpilib | |||
| from wpilib.drive import MecanumDrive | |||
| from wpilib import Joystick, PWMSparkMax, TimedRobot | |||
There was a problem hiding this comment.
I believe we standardised on avoiding from wpilib import over in frc-docs (cf. the Zen of Python). For anything that's in the root wpilib namespace, we should just reference wpilib. similarly to how the C++ examples use frc::TimedRobot and don't do using namespace frc; or similar.
auscompgeek
approved these changes
Sep 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As stated in the #49 issue in the base repository, we need example code that matches WPIlib examples closely.
I may have broken some PEP guidelines, but I believe we need formatting to be in line with C++/Java examples.
The code has been tested in simulation only, because my team does not have any SparkMax motor controllers.