Replace references of frc-docs with wpilib-docs (NFC) (#8926)

This commit is contained in:
sciencewhiz
2026-05-28 08:01:11 -07:00
committed by GitHub
parent f1d95ee5f8
commit 5c3a474a58
33 changed files with 61 additions and 61 deletions

View File

@@ -21,7 +21,7 @@ So you want to contribute your changes back to WPILib. Great! We have a few cont
- Some features, such the addition of C++26 for WPILibC or Functional Interfaces for WPILibJ, are specific to that version of WPILib only. New language features added to C++ must be wrappable in Python for [RobotPy](https://github.com/robotpy).
- Changes should have tests.
- Code should be well documented.
- This involves writing tutorials and/or usage guides for your submitted feature. These articles are then hosted on the [WPILib](https://docs.wpilib.org/) documentation website. See the [frc-docs repository](https://github.com/wpilibsuite/frc-docs) for more information.
- This involves writing tutorials and/or usage guides for your submitted feature. These articles are then hosted on the [WPILib](https://docs.wpilib.org/) documentation website. See the [wpilib-docs repository](https://github.com/wpilibsuite/wpilib-docs) for more information.
## What to Contribute

View File

@@ -7,7 +7,7 @@
#include "wpi/hardware/bus/I2C.hpp"
/**
* ADXL346, 362 Accelerometer snippets for frc-docs.
* ADXL346, 362 Accelerometer snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -8,7 +8,7 @@
#include "wpi/units/acceleration.hpp"
/**
* Collision detection snippets for frc-docs.
* Collision detection snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -9,7 +9,7 @@
#include "wpi/units/acceleration.hpp"
/**
* Accelerometer filtering snippets for frc-docs.
* Accelerometer filtering snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -7,7 +7,7 @@
#include "wpi/hardware/discrete/AnalogInput.hpp"
/**
* AnalogAccelerometer snippets for frc-docs.
* AnalogAccelerometer snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -6,7 +6,7 @@
#include "wpi/hardware/rotation/AnalogEncoder.hpp"
/**
* AnalogEncoder snippets for frc-docs.
* AnalogEncoder snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -6,7 +6,7 @@
#include "wpi/hardware/discrete/AnalogInput.hpp"
/**
* AnalogInput snippets for frc-docs.
* AnalogInput snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/analog-input-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -7,7 +7,7 @@
#include "wpi/hardware/rotation/AnalogPotentiometer.hpp"
/**
* AnalogPotentiometer snippets for frc-docs.
* AnalogPotentiometer snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/analog-potentiometers-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -6,7 +6,7 @@
#include "wpi/hardware/discrete/DigitalInput.hpp"
/**
* Digital Input snippets for frc-docs.
* Digital Input snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/digital-input-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -6,7 +6,7 @@
#include "wpi/hardware/rotation/DutyCycleEncoder.hpp"
/**
* DutyCycleEncoder snippets for frc-docs.
* DutyCycleEncoder snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -7,7 +7,7 @@
#include "wpi/util/deprecated.hpp"
/**
* Encoder snippets for frc-docs.
* Encoder snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
*/
WPI_IGNORE_DEPRECATED

View File

@@ -8,7 +8,7 @@
#include "wpi/hardware/rotation/Encoder.hpp"
/**
* Encoder drive to distance snippets for frc-docs.
* Encoder drive to distance snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -8,7 +8,7 @@
#include "wpi/hardware/rotation/Encoder.hpp"
/**
* Encoder mechanism homing snippets for frc-docs.
* Encoder mechanism homing snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -8,7 +8,7 @@
#include "wpi/hardware/motor/PWMVictorSPX.hpp"
/**
* Limit Switch snippets for frc-docs.
* Limit Switch snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/limit-switch.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -9,7 +9,7 @@
#include "wpi/units/angle.hpp"
/**
* Onboard IMU snippets for frc-docs.
* Onboard IMU snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -13,7 +13,7 @@
#include "wpi/units/voltage.hpp"
/**
* wpi::math::ProfiledPIDController with feedforward snippets for frc-docs.
* wpi::math::ProfiledPIDController with feedforward snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/advanced-controls/controllers/profiled-pidcontroller.html
*/
class Robot : public wpi::TimedRobot {

View File

@@ -1,7 +1,7 @@
[
{
"name": "Encoder",
"description": "Snippets of Encoder class usage for frc-docs.",
"description": "Snippets of Encoder class usage for wpilib-docs.",
"tags": [
"Hardware",
"Encoder"
@@ -11,7 +11,7 @@
},
{
"name": "DutyCycleEncoder",
"description": "Snippets of DutyCycleEncoder class usage for frc-docs.",
"description": "Snippets of DutyCycleEncoder class usage for wpilib-docs.",
"tags": [
"Hardware",
"Encoder",
@@ -22,7 +22,7 @@
},
{
"name": "AnalogEncoder",
"description": "Snippets of AnalogEncoder class usage for frc-docs.",
"description": "Snippets of AnalogEncoder class usage for wpilib-docs.",
"tags": [
"Hardware",
"Encoder",
@@ -33,7 +33,7 @@
},
{
"name": "EncoderDrive",
"description": "Snippets of driving to a distance for frc-docs.",
"description": "Snippets of driving to a distance for wpilib-docs.",
"tags": [
"Hardware",
"Encoder",
@@ -44,7 +44,7 @@
},
{
"name": "EncoderHoming",
"description": "Snippets of homing a mechanism for frc-docs.",
"description": "Snippets of homing a mechanism for wpilib-docs.",
"tags": [
"Hardware",
"Encoder",
@@ -55,7 +55,7 @@
},
{
"name": "LimitSwitch",
"description": "Snippets of Limit Switch for frc-docs.",
"description": "Snippets of Limit Switch for wpilib-docs.",
"tags": [
"Hardware",
"Digital Input"
@@ -65,7 +65,7 @@
},
{
"name": "DigitalInput",
"description": "Snippets of Digital Input for frc-docs.",
"description": "Snippets of Digital Input for wpilib-docs.",
"tags": [
"Hardware",
"Digital Input"
@@ -75,7 +75,7 @@
},
{
"name": "AnalogInput",
"description": "Snippets of Analog Input for frc-docs.",
"description": "Snippets of Analog Input for wpilib-docs.",
"tags": [
"Hardware",
"Analog"
@@ -85,7 +85,7 @@
},
{
"name": "AnalogPotentiometer",
"description": "Snippets of Analog Potentiometer for frc-docs.",
"description": "Snippets of Analog Potentiometer for wpilib-docs.",
"tags": [
"Hardware",
"Analog"
@@ -95,7 +95,7 @@
},
{
"name": "AnalogAccelerometer",
"description": "Snippets of Analog Accelerometer for frc-docs.",
"description": "Snippets of Analog Accelerometer for wpilib-docs.",
"tags": [
"Hardware",
"Analog",
@@ -106,7 +106,7 @@
},
{
"name": "ADXLAccelerometers",
"description": "Snippets of ADXL 345 and 362 Accelerometers for frc-docs.",
"description": "Snippets of ADXL 345 and 362 Accelerometers for wpilib-docs.",
"tags": [
"Hardware",
"Accelerometer"
@@ -116,7 +116,7 @@
},
{
"name": "AccelerometerCollisionDetection",
"description": "Snippets of Accelerometer collision detection for frc-docs.",
"description": "Snippets of Accelerometer collision detection for wpilib-docs.",
"tags": [
"Hardware",
"Accelerometer",
@@ -127,7 +127,7 @@
},
{
"name": "AccelerometerFilter",
"description": "Snippets of filtering Accelerometer for frc-docs.",
"description": "Snippets of filtering Accelerometer for wpilib-docs.",
"tags": [
"Hardware",
"Accelerometer",
@@ -138,7 +138,7 @@
},
{
"name": "OnboardIMU",
"description": "Snippets of OnboardIMU for frc-docs.",
"description": "Snippets of OnboardIMU for wpilib-docs.",
"tags": [
"Hardware",
"Accelerometer",
@@ -149,7 +149,7 @@
},
{
"name": "ProfiledPIDFeedforward",
"description": "Snippets of ProfiledPIDController with feedforward for frc-docs.",
"description": "Snippets of ProfiledPIDController with feedforward for wpilib-docs.",
"tags": [
"PID",
"Profiled PID"

View File

@@ -10,7 +10,7 @@ import org.wpilib.hardware.imu.OnboardIMU.MountOrientation;
import org.wpilib.smartdashboard.SmartDashboard;
/**
* Collision detection snippets for frc-docs.
* Collision detection snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
*/
@SuppressWarnings("checkstyle:VariableDeclarationUsageDistance")

View File

@@ -11,7 +11,7 @@ import org.wpilib.math.filter.LinearFilter;
import org.wpilib.smartdashboard.SmartDashboard;
/**
* Accelerometer filtering snippets for frc-docs.
* Accelerometer filtering snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -9,7 +9,7 @@ import org.wpilib.hardware.accelerometer.ADXL345_I2C;
import org.wpilib.hardware.bus.I2C;
/**
* ADXL345, 362 Accelerometer snippets for frc-docs.
* ADXL345, 362 Accelerometer snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -8,7 +8,7 @@ import org.wpilib.framework.TimedRobot;
import org.wpilib.hardware.accelerometer.AnalogAccelerometer;
/**
* AnalogAccelerometer snippets for frc-docs.
* AnalogAccelerometer snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -8,7 +8,7 @@ import org.wpilib.framework.TimedRobot;
import org.wpilib.hardware.rotation.AnalogEncoder;
/**
* AnalogEncoder snippets for frc-docs.
* AnalogEncoder snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -8,7 +8,7 @@ import org.wpilib.framework.TimedRobot;
import org.wpilib.hardware.discrete.AnalogInput;
/**
* AnalogInput snippets for frc-docs.
* AnalogInput snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/analog-inputs-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -9,7 +9,7 @@ import org.wpilib.hardware.discrete.AnalogInput;
import org.wpilib.hardware.rotation.AnalogPotentiometer;
/**
* AnalogPotentiometer snippets for frc-docs.
* AnalogPotentiometer snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/analog-poteniometers-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -8,7 +8,7 @@ import org.wpilib.framework.TimedRobot;
import org.wpilib.hardware.discrete.DigitalInput;
/**
* DigitalInput snippets for frc-docs.
* DigitalInput snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/digital-inputs-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -8,7 +8,7 @@ import org.wpilib.framework.TimedRobot;
import org.wpilib.hardware.rotation.DutyCycleEncoder;
/**
* DutyCycleEncoder snippets for frc-docs.
* DutyCycleEncoder snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -8,7 +8,7 @@ import org.wpilib.framework.TimedRobot;
import org.wpilib.hardware.rotation.Encoder;
/**
* Encoder snippets for frc-docs.
* Encoder snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
*/
@SuppressWarnings("deprecation")

View File

@@ -10,7 +10,7 @@ import org.wpilib.hardware.motor.Spark;
import org.wpilib.hardware.rotation.Encoder;
/**
* Encoder drive to distance snippets for frc-docs.
* Encoder drive to distance snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -10,7 +10,7 @@ import org.wpilib.hardware.motor.Spark;
import org.wpilib.hardware.rotation.Encoder;
/**
* Encoder mechanism homing snippets for frc-docs.
* Encoder mechanism homing snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/encoders-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -10,7 +10,7 @@ import org.wpilib.hardware.discrete.DigitalInput;
import org.wpilib.hardware.motor.PWMVictorSPX;
/**
* Limit Switch snippets for frc-docs.
* Limit Switch snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/limit-switch.html
*/
public class Robot extends TimedRobot {

View File

@@ -9,7 +9,7 @@ import org.wpilib.hardware.imu.OnboardIMU;
import org.wpilib.hardware.imu.OnboardIMU.MountOrientation;
/**
* on board IMU snippets for frc-docs.
* on board IMU snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/hardware-apis/sensors/accelerometers-software.html
*/
public class Robot extends TimedRobot {

View File

@@ -12,7 +12,7 @@ import org.wpilib.math.controller.SimpleMotorFeedforward;
import org.wpilib.math.trajectory.TrapezoidProfile;
/**
* ProfiledPIDController with feedforward snippets for frc-docs.
* ProfiledPIDController with feedforward snippets for wpilib-docs.
* https://docs.wpilib.org/en/stable/docs/software/advanced-controls/controllers/profiled-pidcontroller.html
*/
public class Robot extends TimedRobot {

View File

@@ -1,7 +1,7 @@
[
{
"name": "Encoder",
"description": "Snippets of Encoder class usage for frc-docs.",
"description": "Snippets of Encoder class usage for wpilib-docs.",
"tags": [
"Hardware",
"Encoder"
@@ -12,7 +12,7 @@
},
{
"name": "DutyCycleEncoder",
"description": "Snippets of DutyCycleEncoder class usage for frc-docs.",
"description": "Snippets of DutyCycleEncoder class usage for wpilib-docs.",
"tags": [
"Hardware",
"Encoder",
@@ -24,7 +24,7 @@
},
{
"name": "AnalogEncoder",
"description": "Snippets of AnalogEncoder class usage for frc-docs.",
"description": "Snippets of AnalogEncoder class usage for wpilib-docs.",
"tags": [
"Hardware",
"Encoder",
@@ -36,7 +36,7 @@
},
{
"name": "EncoderDrive",
"description": "Snippets of driving to a distance for frc-docs.",
"description": "Snippets of driving to a distance for wpilib-docs.",
"tags": [
"Hardware",
"Encoder",
@@ -48,7 +48,7 @@
},
{
"name": "EncoderHoming",
"description": "Snippets of homing a mechanism for frc-docs.",
"description": "Snippets of homing a mechanism for wpilib-docs.",
"tags": [
"Hardware",
"Encoder",
@@ -60,7 +60,7 @@
},
{
"name": "LimitSwitch",
"description": "Snippets of Limit Switch for frc-docs.",
"description": "Snippets of Limit Switch for wpilib-docs.",
"tags": [
"Hardware",
"Digital Input"
@@ -71,7 +71,7 @@
},
{
"name": "DigitalInput",
"description": "Snippets of Digital Input for frc-docs.",
"description": "Snippets of Digital Input for wpilib-docs.",
"tags": [
"Hardware",
"Digital Input"
@@ -82,7 +82,7 @@
},
{
"name": "AnalogInput",
"description": "Snippets of Analog Input for frc-docs.",
"description": "Snippets of Analog Input for wpilib-docs.",
"tags": [
"Hardware",
"Analog"
@@ -93,7 +93,7 @@
},
{
"name": "AnalogPotentiometer",
"description": "Snippets of Analog Potentiometer for frc-docs.",
"description": "Snippets of Analog Potentiometer for wpilib-docs.",
"tags": [
"Hardware",
"Analog"
@@ -104,7 +104,7 @@
},
{
"name": "AnalogAccelerometer",
"description": "Snippets of Analog Accelerometer for frc-docs.",
"description": "Snippets of Analog Accelerometer for wpilib-docs.",
"tags": [
"Hardware",
"Analog",
@@ -116,7 +116,7 @@
},
{
"name": "AccelerometerCollisionDetection",
"description": "Snippets of Accelerometer for collision detection for frc-docs.",
"description": "Snippets of Accelerometer for collision detection for wpilib-docs.",
"tags": [
"Hardware",
"Accelerometer",
@@ -128,7 +128,7 @@
},
{
"name": "AccelerometerFilter",
"description": "Snippets of filtering Accelerometer for frc-docs.",
"description": "Snippets of filtering Accelerometer for wpilib-docs.",
"tags": [
"Hardware",
"Accelerometer",
@@ -140,7 +140,7 @@
},
{
"name": "ADXLAccelerometers",
"description": "Snippets of ADXL 345 and 362 accelerometers for frc-docs.",
"description": "Snippets of ADXL 345 and 362 accelerometers for wpilib-docs.",
"tags": [
"Hardware",
"Accelerometer"
@@ -151,7 +151,7 @@
},
{
"name": "OnboardIMU",
"description": "Snippets of Onboard IMU for frc-docs.",
"description": "Snippets of Onboard IMU for wpilib-docs.",
"tags": [
"Hardware",
"Accelerometer",
@@ -163,7 +163,7 @@
},
{
"name": "ProfiledPIDFeedforward",
"description": "Snippets of ProfiledPIDController with feedforward for frc-docs.",
"description": "Snippets of ProfiledPIDController with feedforward for wpilib-docs.",
"tags": [
"PID",
"Profiled PID"