Add Python inline examples to hardware APIs and command-based docs#3112
Open
jasondaming wants to merge 3 commits intowpilibsuite:mainfrom
Open
Add Python inline examples to hardware APIs and command-based docs#3112jasondaming wants to merge 3 commits intowpilibsuite:mainfrom
jasondaming wants to merge 3 commits intowpilibsuite:mainfrom
Conversation
This commit adds Python code examples to documentation files that previously only had Java and C++ inline examples. This is part of the effort to complete Python documentation coverage (Issue wpilibsuite#1818). Files updated: - counters.rst: Added 13 Python examples for all counter modes and operations - accelerometers-software.rst: Added 7 Python examples for accelerometer types - solenoids.rst: Added 1 Python example for solenoid toggling - binding-commands-to-triggers.rst: Added 6 Python examples for trigger bindings All examples follow Python naming conventions (snake_case) and use idiomatic Python patterns while maintaining semantic equivalence with the Java/C++ examples. Addresses wpilibsuite#1818
Added 11 Python code examples demonstrating command organization patterns: - Inline commands with StartEndCommand - Instance factory methods in subsystems - Static and non-static command factories - Capturing state in inline commands with PID controllers - Subclassing Command for complex logic - Subclassing SequentialCommandGroup All examples follow Python idioms while maintaining semantic equivalence with Java/C++ examples. Addresses wpilibsuite#1818
sciencewhiz
reviewed
Oct 13, 2025
Collaborator
sciencewhiz
left a comment
sciencewhiz
left a comment
There was a problem hiding this comment.
Have you ensured that these run and work? I'm worried about hallucinations.
It looks like the python examples use camelCase, not underscore_case
| ``` | ||
|
|
||
| ```python | ||
| (example_button |
Fixed import paths for command-based classes: - Changed CommandXboxController import from wpilib to commands2.button - Changed JoystickButton import from wpilib.buttons to commands2.button - Changed Trigger import from commands2 to commands2.button These classes are located in the commands2.button package in RobotPy, not in wpilib. Using incorrect import paths would cause ImportError for Python users. Also fixed Trigger lambda to use lambda: limit_switch.get() instead of just limit_switch.get to match the lambda pattern in Java/C++. Fixed solenoids.rst context issue: - Removed self.controller reference that had no class context - Added XboxController import and created controller instance at module level - This makes the example runnable without needing to be in a class All other Python examples in counters.rst, accelerometers-software.rst, and organizing-command-based.rst were verified to be correct. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Adds Python code examples to 5 documentation files that previously only had Java and C++ inline examples, as part of Issue #1818.
Changes
Files Updated
Code Style
Total Impact
38 Python code examples added across 5 files, significantly improving Python documentation coverage.
Progress on Issue #1818
This PR addresses all inline examples in existing files that were missing Python versions. Additional work for #1818 includes:
Addresses #1818