Skip to content

Commit

Permalink
Update RLIs for 2025.2.1 (#2933)
Browse files Browse the repository at this point in the history
* Update RLIs for 2025.2.1

* Autofix RLIs

---------

Co-authored-by: github-actions <[email protected]>
  • Loading branch information
sciencewhiz and github-actions authored Jan 11, 2025
1 parent 2d77d87 commit bc3e53f
Show file tree
Hide file tree
Showing 25 changed files with 161 additions and 161 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/inspector.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
{
"baseUrl": "https://raw.githubusercontent.com/wpilibsuite/allwpilib/",
"versionScheme": "v\\d{4}\\.\\d\\.\\d(?:-(?:alpha|beta)-\\d)?|[0-9a-f]{40}",
"latestVersion": "v2025.1.1"
"latestVersion": "v2025.2.1"
},
{
"baseUrl": "https://github.com/wpilibsuite/allwpilib/raw/",
"versionScheme": "v\\d{4}\\.\\d\\.\\d(?:-(?:alpha|beta)-\\d)?|[0-9a-f]{40}",
"latestVersion": "v2025.1.1"
"latestVersion": "v2025.2.1"
},
{
"baseUrl": "https://raw.githubusercontent.com/robotpy/examples/",
Expand Down
6 changes: 3 additions & 3 deletions source/docs/contributing/frc-docs/style-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,12 @@ Follow the [WPILib style guide](https://github.com/wpilibsuite/styleguide/) for
When possible, instead of using code blocks, an RLI should be used. This pulls code lines directly from GitHub, most commonly using the example programs. This automatically keeps the code up to date with any changes that are made. The format of an RLI is:

```ReST
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/gettingstarted/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/gettingstarted/Robot.java
:language: java
:lines: 19-25
:lineno-match:
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/GettingStarted/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/GettingStarted/cpp/Robot.cpp
:language: c++
:lines: 50-60
:lineno-match:
Expand All @@ -126,7 +126,7 @@ To create code tabs in an article, you can use the ``.. tab-set-code::`` directi

````ReST
.. tab-set-code::
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/gettingstarted/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/gettingstarted/Robot.java
:language: java
:lines: 19-25
:lineno-match:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,12 @@ A more complete example of ``ProfiledPIDController`` usage is provided in the El

.. tab-set-code::

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatorprofiledpid/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatorprofiledpid/Robot.java
:language: java
:lines: 5-
:lineno-match:

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/ElevatorProfiledPID/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/ElevatorProfiledPID/cpp/Robot.cpp
:language: c++
:lines: 5-
:lineno-match:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,12 +162,12 @@ A more complete example of ``TrapezoidProfile`` usage is provided in the Elevato

.. tab-set-code::

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatortrapezoidprofile/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatortrapezoidprofile/Robot.java
:language: java
:lines: 5-
:lineno-match:

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/ElevatorTrapezoidProfile/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/ElevatorTrapezoidProfile/cpp/Robot.cpp
:language: c++
:lines: 5-
:lineno-match:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The ``LinearSystem`` class contains methods for easily creating state-space syst
.. tab-item:: Java
:sync: java

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheelsysid/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheelsysid/Robot.java
:language: java
:lines: 32-46
:lineno-match:
Expand All @@ -74,12 +74,12 @@ The ``LinearSystem`` class contains methods for easily creating state-space syst
.. tab-item:: C++
:sync: c++

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
:language: c++
:lines: 17
:lineno-match:

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
:language: c++
:lines: 30-46
:lineno-match:
Expand Down Expand Up @@ -112,20 +112,20 @@ The ``LinearSystem`` class contains methods to easily create a model of a flywhe
.. tab-item:: Java
:sync: java

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
:language: java
:lines: 33-46
:lineno-match:

.. tab-item:: C++
:sync: c++

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
:language: c++
:lines: 17-17
:lineno-match:

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
:language: c++
:lines: 31-46
:lineno-match:
Expand Down Expand Up @@ -161,20 +161,20 @@ Because the feedback controller computes error using the :term:`x-hat` estimated
.. tab-item:: Java
:sync: java

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
:language: java
:lines: 48-58
:lineno-match:

.. tab-item:: C++
:sync: c++

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
:language: c++
:lines: 13-13
:lineno-match:

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
:language: c++
:lines: 48-53
:lineno-match:
Expand Down Expand Up @@ -202,20 +202,20 @@ Much like ``SimpleMotorFeedforward`` can be used to generate feedforward voltage
.. tab-item:: Java
:sync: java

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
:language: java
:lines: 59-70
:lineno-match:

.. tab-item:: C++
:sync: c++

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
:language: c++
:lines: 11
:lineno-match:

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
:language: c++
:lines: 55-75
:lineno-match:
Expand All @@ -237,20 +237,20 @@ LinearSystemLoop combines our system, controller, and observer that we created e
.. tab-item:: Java
:sync: java

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
:language: java
:lines: 72-74
:lineno-match:

.. tab-item:: C++
:sync: c++

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
:language: c++
:lines: 15-15
:lineno-match:

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
:language: c++
:lines: 71-74
:lineno-match:
Expand All @@ -270,20 +270,20 @@ Once we have our ``LinearSystemLoop``, the only thing left to do is actually run
.. tab-item:: Java
:sync: java

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
:language: java
:lines: 94-119
:lineno-match:

.. tab-item:: C++
:sync: c++

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
:language: c++
:lines: 5-17
:lineno-match:

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
:language: c++
:lines: 92-114
:lineno-match:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,19 +91,19 @@ WPILib's Kalman Filter classes' constructors take a linear system, a vector of p
.. tab-set::
.. tab-item:: Java

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
:language: java
:lines: 48-57
:lineno-match:

.. tab-item:: C++

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
:language: c++
:lines: 5-18
:lineno-match:

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
:language: c++
:lines: 48-53
:lineno-match:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,6 @@ modifiableFileExclude {

You can turn this into a :doc:`CI check <robot-code-ci>` by running ``git --no-pager diff --exit-code HEAD``, as shown in the example GitHub Actions workflow below:

.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/.github/workflows/lint-format.yml
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/.github/workflows/lint-format.yml
:language: yaml
:lines: 1-5, 13, 21-43
20 changes: 10 additions & 10 deletions source/docs/software/basic-programming/robot-preferences.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@ This example shows how to utilize Preferences to change the setpoint of a PID co
.. tab-item:: Java
:sync: Java

.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/armsimulation/Constants.java
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/armsimulation/Constants.java
:language: java
:lines: 15-20

.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/armsimulation/subsystems/Arm.java
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/armsimulation/subsystems/Arm.java
:language: java
:lines: 27-29, 73-74, 80-83

.. tab-item:: C++
:sync: C++

.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/ArmSimulation/include/Constants.h
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/ArmSimulation/include/Constants.h
:language: c++
:lines: 30-34

.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/ArmSimulation/cpp/subsystems/Arm.cpp
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/ArmSimulation/cpp/subsystems/Arm.cpp
:language: c++
:lines: 12, 18-22

Expand Down Expand Up @@ -55,14 +55,14 @@ If using the Command Framework, this type of code could be placed in the constru
.. tab-item:: Java
:sync: Java

.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/armsimulation/subsystems/Arm.java
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/armsimulation/subsystems/Arm.java
:language: java
:lines: 105-112

.. tab-item:: C++
:sync: C++

.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/ArmSimulation/cpp/subsystems/Arm.cpp
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/ArmSimulation/cpp/subsystems/Arm.cpp
:language: c++
:lines: 44-52

Expand All @@ -82,20 +82,20 @@ Depending on the data that is stored in preferences, you can use it when you rea
.. tab-item:: Java
:sync: Java

.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/armsimulation/Robot.java
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/armsimulation/Robot.java
:language: java
:lines: 28-37
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/armsimulation/subsystems/Arm.java
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/armsimulation/subsystems/Arm.java
:language: java
:lines: 114-120

.. tab-item:: C++
:sync: C++

.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/ArmSimulation/cpp/Robot.cpp
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/ArmSimulation/cpp/Robot.cpp
:language: c++
:lines: 15-24
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.1.1/wpilibcExamples/src/main/cpp/examples/ArmSimulation/cpp/subsystems/Arm.cpp
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/ArmSimulation/cpp/subsystems/Arm.cpp
:language: c++
:lines: 54-60

Expand Down
Loading

0 comments on commit bc3e53f

Please sign in to comment.