Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- when asked to handle an issue you will need to create a new branch with which to work from
- When creating a PR no need to do created by claude code
- Please don't include the test plan in the PR
- Please always check when modifying files that we are updating the redirects and searching for links to any files that may be affected by changes we made
202 changes: 202 additions & 0 deletions MISSING_PYTHON_EXAMPLES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
# Files Missing Python Examples

**For Issue #1818** - Adding Python examples throughout the documentation

**Total files needing Python examples: 56**

*Generated: 2025-10-07*

---

## Summary by Category

- **software/hardware-apis**: 11 files (HIGH PRIORITY)
- **software/commandbased**: 7 files (HIGH PRIORITY)
- **software/basic-programming**: 2 files (HIGH PRIORITY)
- **software/pathplanning**: 4 files (HIGH PRIORITY)
- **software/wpilib-tools**: 15 files (HIGH PRIORITY)
- **software/convenience-features**: 2 files
- **software/dashboards**: 4 files
- **software/advanced-controls**: 2 files
- **software/networktables**: 1 files
- **software/telemetry**: 2 files
- **software/vision-processing**: 1 files
- **software/vscode-overview**: 2 files
- **software/roborio-info**: 1 files
- **software/can-devices**: 1 files
- **yearly-overview/2020-Game-Data.rst**: 1 files

---

## Detailed File List


### Software/Hardware-Apis :star:

- `software/hardware-apis/misc/addressable-leds.rst`
- Present: Java (20 blocks), C++ (20 blocks)
- `software/hardware-apis/pneumatics/pressure.rst`
- Present: Java (6 blocks), C++ (6 blocks)
- `software/hardware-apis/pneumatics/solenoids.rst`
- Present: Java (3 blocks), C++ (3 blocks)
- `software/hardware-apis/sensors/accelerometers-software.rst`
- Present: Java (8 blocks), C++ (8 blocks)
- `software/hardware-apis/sensors/analog-inputs-software.rst`
- Present: Java (9 blocks)
- `software/hardware-apis/sensors/analog-potentiometers-software.rst`
- Present: Java (3 blocks), C++ (1 blocks)
- `software/hardware-apis/sensors/counters.rst`
- Present: Java (13 blocks), C++ (13 blocks)
- `software/hardware-apis/sensors/digital-inputs-software.rst`
- Present: Java (4 blocks)
- `software/hardware-apis/sensors/encoders-software.rst`
- Present: Java (18 blocks), C++ (1 blocks)
- `software/hardware-apis/sensors/limit-switch.rst`
- Present: Java (1 blocks)
- `software/hardware-apis/sensors/ultrasonics-software.rst`
- Present: Java (4 blocks), C++ (4 blocks)

### Software/Commandbased :star:

- `software/commandbased/binding-commands-to-triggers.rst`
- Present: Java (9 blocks), C++ (6 blocks)
- `software/commandbased/command-scheduler.rst`
- Present: Java (6 blocks), C++ (6 blocks)
- `software/commandbased/organizing-command-based.rst`
- Present: Java (12 blocks), C++ (12 blocks)
- `software/commandbased/pid-subsystems-commands.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/commandbased/profile-subsystems-commands.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/commandbased/profilepid-subsystems-commands.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/commandbased/structuring-command-based-project.rst`
- Present: Java (9 blocks), C++ (8 blocks)

### Software/Basic-Programming :star:

- `software/basic-programming/alliancecolor.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/basic-programming/reading-stacktraces.rst`
- Present: Java (4 blocks), C++ (4 blocks)

### Software/Pathplanning :star:

- `software/pathplanning/pathweaver/integrating-robot-program.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/pathplanning/trajectory-tutorial/creating-drive-subsystem.rst`
- Present: Java (11 blocks), C++ (11 blocks)
- `software/pathplanning/trajectory-tutorial/creating-following-trajectory.rst`
- Present: Java (6 blocks), C++ (6 blocks)
- `software/pathplanning/trajectory-tutorial/entering-constants.rst`
- Present: Java (4 blocks)

### Software/Wpilib-Tools :star:

- `software/wpilib-tools/robot-simulation/device-sim.rst`
- Present: Java (5 blocks), C++ (5 blocks)
- `software/wpilib-tools/robot-simulation/drivesim-tutorial/drivetrain-model.rst`
- Present: Java (3 blocks), C++ (3 blocks)
- `software/wpilib-tools/robot-simulation/drivesim-tutorial/odometry-simgui.rst`
- Present: Java (3 blocks), C++ (3 blocks)
- `software/wpilib-tools/robot-simulation/drivesim-tutorial/simulation-instance.rst`
- Present: Java (2 blocks), C++ (2 blocks)
- `software/wpilib-tools/robot-simulation/drivesim-tutorial/updating-drivetrain-model.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/wpilib-tools/robot-simulation/physics-sim.rst`
- Present: Java (3 blocks), C++ (3 blocks)
- `software/wpilib-tools/robot-simulation/simulation-gui.rst`
- Present: Java (1 blocks)
- `software/wpilib-tools/robot-simulation/unit-testing.rst`
- Present: Java (2 blocks), C++ (2 blocks)
- `software/wpilib-tools/robotbuilder/advanced/robotbuilder-custom-components.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/wpilib-tools/robotbuilder/advanced/robotbuilder-writing-pidsubsystem-code.rst`
- Present: Java (3 blocks), C++ (3 blocks)
- `software/wpilib-tools/robotbuilder/introduction/robotbuilder-created-code.rst`
- Present: Java (4 blocks), C++ (4 blocks)
- `software/wpilib-tools/robotbuilder/introduction/robotbuilder-testing-with-shuffleboard.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/wpilib-tools/robotbuilder/writing-code/robotbuilder-drive-tank.rst`
- Present: C++ (2 blocks)
- `software/wpilib-tools/robotbuilder/writing-code/robotbuilder-writing-command-code.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/wpilib-tools/robotbuilder/writing-code/robotbuilder-writing-subsystem-code.rst`
- Present: Java (1 blocks), C++ (2 blocks)

### Software/Convenience-Features

- `software/convenience-features/event-based.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/convenience-features/scheduling-functions.rst`
- Present: Java (2 blocks), C++ (3 blocks)

### Software/Dashboards

- `software/dashboards/shuffleboard/custom-widgets/creating-a-new-widget.rst`
- Present: Java (7 blocks)
- `software/dashboards/shuffleboard/custom-widgets/creating-custom-data-types.rst`
- Present: Java (6 blocks)
- `software/dashboards/shuffleboard/custom-widgets/creating-plugins.rst`
- Present: Java (2 blocks)
- `software/dashboards/smartdashboard/smartdashboard-namespace.rst`
- Present: Java (2 blocks)

### Software/Advanced-Controls

- `software/advanced-controls/state-space/state-space-pose-estimators.rst`
- Present: Java (3 blocks)
- `software/advanced-controls/trajectories/troubleshooting.rst`
- Present: Java (4 blocks), C++ (3 blocks)

### Software/Networktables

- `software/networktables/custom-serialization.rst`
- Present: Java (12 blocks), C++ (3 blocks)

### Software/Telemetry

- `software/telemetry/robot-telemetry-with-annotations.rst`
- Present: Java (6 blocks)
- `software/telemetry/writing-sendable-classes.rst`
- Present: Java (2 blocks)

### Software/Vision-Processing

- `software/vision-processing/introduction/cameraserver-class.rst`
- Present: Java (2 blocks), C++ (2 blocks)

### Software/Vscode-Overview

- `software/vscode-overview/creating-robot-program.rst`
- Present: Java (1 blocks), C++ (1 blocks)
- `software/vscode-overview/debugging-robot-program.rst`
- Present: Java (1 blocks), C++ (1 blocks)

### Software/Roborio-Info

- `software/roborio-info/roborio-brownouts.rst`
- Present: Java (1 blocks), C++ (1 blocks)

### Software/Can-Devices

- `software/can-devices/can-addressing.rst`
- Present: C++ (1 blocks)

### Yearly-Overview/2020-Game-Data.Rst

- `yearly-overview/2020-Game-Data.rst`
- Present: Java (1 blocks), C++ (1 blocks)

---

## Notes

- Files marked with :star: are HIGH PRIORITY (core APIs and frameworks)
- The following language-specific files were excluded:
- `software/advanced-gradlerio/code-formatting.rst` - Java-specific code formatting (GradleRIO)
- `software/basic-programming/cpp-units.rst` - C++-specific units library documentation
- `software/basic-programming/functions-as-data.rst` - Language-specific feature comparison
- `software/basic-programming/java-gc.rst` - Java-specific garbage collection documentation
- `software/basic-programming/java-units.rst` - Java-specific units library documentation
- `software/commandbased/cpp-command-discussion.rst` - C++-specific technical discussion
Loading