fix spelling mistakes

WispySparks · WispySparks · commit ee7e4a03141b · 2024-08-18T18:40:27.000-05:00
diff --git a/source/_extensions/controls_js_sim/__init__.py b/source/_extensions/controls_js_sim/__init__.py
@@ -6,7 +6,7 @@
 from sphinx.application import Sphinx
 
 # Handle custom javascript
-# Groups, sorts, merges, and minifies the JS files assocated with
+# Groups, sorts, merges, and minifies the JS files associated with
 # the controls documentation
 
 debugJS = False  # flip to true to make the output js more readable
diff --git a/source/_extensions/wpilib_release.py b/source/_extensions/wpilib_release.py
@@ -45,7 +45,7 @@ def get_url_size(osname):
         mac_arm_download_url_part, mac_arm_size = get_url_size("macOSArm")
 
         # There's something weird going where the hashes are all printed on one line.
-        # This works aroung that.
+        # This works around that.
         release_notes = release["body"].replace("\r", "")
 
         r2 = release_notes.split("```")
diff --git a/source/docs/hardware/sensors/accelerometers-hardware.rst b/source/docs/hardware/sensors/accelerometers-hardware.rst
@@ -25,7 +25,7 @@ As per their name, single-axis accelerometers measure acceleration along a singl
 .. image:: images/analog-inputs-hardware/triple-axis-accelerometer-to-roborio.svg
   :alt: The triple axis accelerometer hooked up to three different Analog In channels.
 
-Multi-axis accelerometers measure acceleration along multiple spacial axes.  The roboRIO's built-in accelerometer is a three-axis accelerometer.
+Multi-axis accelerometers measure acceleration along multiple spatial axes.  The roboRIO's built-in accelerometer is a three-axis accelerometer.
 
 Peripheral multi-axis accelerometers may simply output multiple analog voltages (and thus connect to the :ref:`analog input ports <docs/hardware/sensors/analog-inputs-hardware:Connecting a sensor to multiple analog input ports>`, or (more commonly) they may communicate with one of the roboRIO's :doc:`serial buses <serial-buses>`.
 
diff --git a/source/docs/hardware/sensors/gyros-hardware.rst b/source/docs/hardware/sensors/gyros-hardware.rst
@@ -32,7 +32,7 @@ The [Analog Devices ADXRS450 FRC Gyro Board](https://www.analog.com/en/landing-p
   :alt: This is the ADIS16470 :term:`IMU` plugged in to the SPI port.
   :width: 400
 
-Three-axis gyros measure rotation rate around all three spacial axes (typically labeled x, y, and z). The motion around these axis is called pitch, yaw, and roll.
+Three-axis gyros measure rotation rate around all three spatial axes (typically labeled x, y, and z). The motion around these axis is called pitch, yaw, and roll.
 
 The [Analog Devices ADIS16470 IMU Board for FIRST Robotics](https://www.analog.com/en/landing-pages/001/first.html) that has been in FIRST Choice in recent years is a commonly used three-axis gyro.
 
diff --git a/source/docs/software/advanced-controls/system-identification/creating-routine.rst b/source/docs/software/advanced-controls/system-identification/creating-routine.rst
@@ -11,7 +11,7 @@ Each test type is run both forwards and backwards, for four tests in total. The
 
 ## User Code Setup
 
-.. note:: Some familiarity with your language's units library is recommended and knowing how to use Consumers is required. Ths page assumes you are using the Commands framework.
+.. note:: Some familiarity with your language's units library is recommended and knowing how to use Consumers is required. This page assumes you are using the Commands framework.
 
 To assist in creating SysId-compatible identification routines, WPILib provides the ``SysIdRoutine`` class. Users should create a ``SysIdRoutine`` object, which take both a ``Config`` object describing the test settings and a ``Mechanism`` object describing how the routine will control the relevant motors and log the measurements needed to perform the fit.
 
diff --git a/source/docs/software/advanced-controls/system-identification/loading-data.rst b/source/docs/software/advanced-controls/system-identification/loading-data.rst
@@ -4,7 +4,7 @@ After downloading the WPILog containing the tests from the roboRIO, go to the ``
 
 After the file loads, look for a ``string`` type entry with a name containing "state". Drag this entry into the Data Selector pane's Test State slot.
 
-.. note:: SysIdRoutine will name the entry "sysid-test-state-mechanism", where "mechanism" is the name passed to the ``Mechanism`` contructor or the subsystem name.
+.. note:: SysIdRoutine will name the entry "sysid-test-state-mechanism", where "mechanism" is the name passed to the ``Mechanism`` constructor or the subsystem name.
 
 .. image:: images/log-loaded.png
     :alt: Log Loader and Data Selector panes showing the test state entry and where to move it
diff --git a/source/docs/software/advanced-controls/trajectories/troubleshooting.rst b/source/docs/software/advanced-controls/trajectories/troubleshooting.rst
@@ -220,7 +220,7 @@ If your feedforwards are bad then the P controllers for each side of the robot w
 ### Verify P Gain
 If you completed the previous step and the problem went away then your problem can probably be found in one of the next steps. In this step we're going to verify that your wheel P controllers are well-tuned. If you're using Java then we want to turn off Ramsete so that we can just view our PF controllers on their own.
 
-1. You must re-use all the code from the previous step that logs actual vs. desired velocity (and the code that disables Ramsete, if you're using Java), except that **the P gain must be set back to its previous nonzero value.**
+1. You must reuse all the code from the previous step that logs actual vs. desired velocity (and the code that disables Ramsete, if you're using Java), except that **the P gain must be set back to its previous nonzero value.**
 2. Run the robot again on a variety of trajectories, and check that your actual vs. desired graphs look good.
 3. If the graphs do not look good (i.e. the actual velocity is very different from the desired) then you should try tuning your P gain and rerunning your test trajectories.
 
diff --git a/source/docs/software/basic-programming/java-units.rst b/source/docs/software/basic-programming/java-units.rst
@@ -78,7 +78,7 @@ The ``Measure`` class also supports arithmetic operations, such as addition, sub
 
 In this code, the units library will automatically convert the measures to the same unit before adding the two distances. The resulting ``totalDistance`` object will be a new ``Measure<Distance>`` object that has a value of 0.508 meters, or 20 inches.
 
-This example combines the wheel diameter and gear ratio to calcualate the distance per rotation of the wheel:
+This example combines the wheel diameter and gear ratio to calculate the distance per rotation of the wheel:
 
 .. code-block:: java
 
diff --git a/source/docs/software/commandbased/command-compositions.rst b/source/docs/software/commandbased/command-compositions.rst
@@ -85,7 +85,7 @@ There are three types of parallel compositions, differing based on when the comp
 
 - The ``Parallel`` factory ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/Commands.html#parallel(edu.wpi.first.wpilibj2.command.Command...)), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/namespacefrc2_1_1cmd.html#ac98ed0faaf370bde01be52bd631dc4e8), :external:py:func:[Python](commands2.cmd.parallel>`), backed by the ``ParallelCommandGroup`` class ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/ParallelCommandGroup.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc2_1_1_parallel_command_group.html), :external:py:class:[Python](commands2.ParallelCommandGroup>`), constructs a parallel composition that finishes when all members finish. The ``alongWith`` decorator ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/Command.html#alongWith(edu.wpi.first.wpilibj2.command.Command...)), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc2_1_1_command_ptr.html#a6b9700cd25277a3ac558d63301985f40), :external:py:meth:`Python <commands2.Command.alongWith>`) does the same in infix notation.
 - The ``Race`` factory ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/Commands.html#race(edu.wpi.first.wpilibj2.command.Command...)), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/namespacefrc2_1_1cmd.html#a5253e241cf1e19eddfb79e2311068ac5), :external:py:func:[Python](commands2.cmd.race>`), backed by the ``ParallelRaceGroup`` class ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/ParallelRaceGroup.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc2_1_1_parallel_race_group.html), :external:py:class:[Python](commands2.ParallelRaceGroup>`), constructs a parallel composition that finishes as soon as any member finishes; all other members are interrupted at that point.  The ``raceWith`` decorator ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/Command.html#raceWith(edu.wpi.first.wpilibj2.command.Command...)), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc2_1_1_command_ptr.html#a4d6c1761cef10bb79a727e43e89643d0), :external:py:meth:`Python <commands2.Command.raceWith>`) does the same in infix notation.
-- The ``Deadline`` factory ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/Commands.html#deadline(edu.wpi.first.wpilibj2.command.Command,edu.wpi.first.wpilibj2.command.Command...)), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/namespacefrc2_1_1cmd.html#a91073d40910a70f1e2d02c7ce320196a), :external:py:func:[Python](commands2.cmd.deadline>`), ``ParallelDeadlineGroup`` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/ParallelDeadlineGroup.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc2_1_1_parallel_deadline_group.html), :external:py:class:[Python](commands2.ParallelDeadlineGroup>`) finishes when a specific command (the "deadline") ends; all other members still running at that point are interrupted.  The ``deadlineWith`` decorator (`Java <https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/Command.html#deadlineWith(edu.wpi.first.wpilibj2.command.Command...)), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc2_1_1_command_ptr.html#afafe81bf1624eb0ef78b30232087b4bf), :external:py:meth:`Python <commands2.Command.deadlineWith>`) does the same in infix notation; the comand the decorator was called on is the deadline.
+- The ``Deadline`` factory ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/Commands.html#deadline(edu.wpi.first.wpilibj2.command.Command,edu.wpi.first.wpilibj2.command.Command...)), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/namespacefrc2_1_1cmd.html#a91073d40910a70f1e2d02c7ce320196a), :external:py:func:[Python](commands2.cmd.deadline>`), ``ParallelDeadlineGroup`` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/ParallelDeadlineGroup.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc2_1_1_parallel_deadline_group.html), :external:py:class:[Python](commands2.ParallelDeadlineGroup>`) finishes when a specific command (the "deadline") ends; all other members still running at that point are interrupted.  The ``deadlineWith`` decorator (`Java <https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj2/command/Command.html#deadlineWith(edu.wpi.first.wpilibj2.command.Command...)), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc2_1_1_command_ptr.html#afafe81bf1624eb0ef78b30232087b4bf), :external:py:meth:`Python <commands2.Command.deadlineWith>`) does the same in infix notation; the command the decorator was called on is the deadline.
 
 .. tab-set-code::
 
diff --git a/source/docs/software/commandbased/what-is-command-based.rst b/source/docs/software/commandbased/what-is-command-based.rst
@@ -2,7 +2,7 @@
 
 WPILib supports a robot programming methodology called "command-based" programming. In general, "command-based" can refer both the general programming paradigm, and to the set of WPILib library resources included to facilitate it.
 
-"Command-based" programming is one possible :term:`design pattern` for robot software. It is not the only way to write a robot program, but it is a very effective one. Command-based robot code tends to be clean, extensible, and (with some tricks) easy to re-use from year to year.
+"Command-based" programming is one possible :term:`design pattern` for robot software. It is not the only way to write a robot program, but it is a very effective one. Command-based robot code tends to be clean, extensible, and (with some tricks) easy to reuse from year to year.
 
 The command-based paradigm is also an example of :term:`declarative programming`. The command-based library allow users to define desired robot behaviors while minimizing the amount of iteration-by-iteration robot logic that they must write. For example, in the command-based program, a user can specify that "the robot should perform an action when a condition is true" (note the use of a :ref:`lambda <docs/software/commandbased/index:Lambda Expressions (Java)>`):
 
diff --git a/source/docs/software/dashboards/shuffleboard/custom-widgets/creating-plugins.rst b/source/docs/software/dashboards/shuffleboard/custom-widgets/creating-plugins.rst
@@ -33,7 +33,7 @@ Plugin classes are permitted to have a default constructor but it cannot take an
 
 ## Building plugin
 
-The easiest way to build plugins is to utlize the `example-plugins` folder in the shufflebloard source tree. Clone Shuffleboard with ``git clone https://github.com/wpilibsuite/shuffleboard.git``, and checkout the version that corresponds to the WPILib version you have installed (e.g. 2023.2.1). ``git checkout v2023.2.1``
+The easiest way to build plugins is to utilize the `example-plugins` folder in the shufflebloard source tree. Clone Shuffleboard with ``git clone https://github.com/wpilibsuite/shuffleboard.git``, and checkout the version that corresponds to the WPILib version you have installed (e.g. 2023.2.1). ``git checkout v2023.2.1``
 
 Put your plugin in the ``example-plugins\PLUGIN-NAME`` directory.
 Copy the ``custom-data-and-widget.gradle`` from ``example-plugins\custom-data-and-widget`` and rename to match your plugin name.
diff --git a/source/docs/software/driverstation/driver-station-errors-warnings.rst b/source/docs/software/driverstation/driver-station-errors-warnings.rst
@@ -50,11 +50,11 @@ This message is printed each time the DS begins communicating with the roboRIO.
 
   WARNING<Code>44008 occurred at FRC_NetworkCommunications
   <radioLostEvents> 19.004<radioSeenEvents> 0.000
-  FRC: Robot radio dectection times
+  FRC: Robot radio detection times
 
   WARNING<Code>44008 occurred at FRC_NetworkCommunications
   <radioLostEvents> 2.501,422.008<radioSeenEvents> 0.000,147.005
-  FRC: Robot radio dectection times.
+  FRC: Robot radio detection times.
 
 This message may be printed when the DS begins communicating with the roboRIO and indicates the time, in seconds, since the last time the radio was lost and seen. In the first example image above the message indicates that the roboRIO's connection to the radio was lost 19 seconds before the message was printed and the radio was seen again right when the message was printed. If multiple radioLost or radioSeen events have occurred since the roboRIO booted, up to 2 events of each type will be included, separated by commas.
 
diff --git a/source/docs/software/hardware-apis/motors/wpi-drive-classes.rst b/source/docs/software/hardware-apis/motors/wpi-drive-classes.rst
@@ -148,14 +148,14 @@ DifferentialDrive is a method provided for the control of "skid-steer" or "West
 
 ### Multi-Motor DifferentialDrive
 
-Many FRC\ |reg| drivetrains have more than 1 motor on each side. Classes derived from ``PWMMotorController`` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/motorcontrol/PWMMotorController.html) / [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_p_w_m_motor_controller.html) / :external:py:class:`Python <wpilib.PWMMotorController>`) have an ``addFollower`` method so that multiple follower motor controllers can be updated when the leader motor controller is commanded. CAN motor controllers have similar features, review the vendor's documention to see how to use them. The examples below show a 4 motor (2 per side) drivetrain. To extend to more motors, simply create the additional controllers and use additional ``addFollower`` calls.
+Many FRC\ |reg| drivetrains have more than 1 motor on each side. Classes derived from ``PWMMotorController`` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/motorcontrol/PWMMotorController.html) / [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_p_w_m_motor_controller.html) / :external:py:class:`Python <wpilib.PWMMotorController>`) have an ``addFollower`` method so that multiple follower motor controllers can be updated when the leader motor controller is commanded. CAN motor controllers have similar features, review the vendor's documentation to see how to use them. The examples below show a 4 motor (2 per side) drivetrain. To extend to more motors, simply create the additional controllers and use additional ``addFollower`` calls.
 
 .. tab-set::
 
     .. tab-item:: Java
      :sync: Java
 
-        Class variables (e.g. in Robot.java or Subystem):
+        Class variables (e.g. in Robot.java or Subsystem):
 
         .. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.3.2/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/ramsetecommand/subsystems/DriveSubsystem.java
             :language: java
diff --git a/source/docs/software/telemetry/robot-telemetry-with-annotations.rst b/source/docs/software/telemetry/robot-telemetry-with-annotations.rst
@@ -259,7 +259,7 @@ Logging Third-Party Data
 
 A large part of the Java ecosystem is its access to third-party libraries that provide extra functionality, such as vendor libraries for interacting with custom hardware like motor controllers and sensors. If those vendors do not use logging annotations in their libraries, then you can still log them by writing a custom logger class! These classes are actually what the WPILib annotations will generate; you just write a custom one because third-party code cannot be annotated.
 
-Custom loggers can be declared in any package, and only need to have the ``@CustomLoggerFor`` annotation present to be able to be detected and used. They must extend from ``ClassSpecificLogger`` ([Javadoc](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/epilogue/logging/ClassSpecificLogger.html)) and must have a public no-argument construtor - failing to declare one will result in a compilation error - and must pass the type they log to the superclass constructor.
+Custom loggers can be declared in any package, and only need to have the ``@CustomLoggerFor`` annotation present to be able to be detected and used. They must extend from ``ClassSpecificLogger`` ([Javadoc](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/epilogue/logging/ClassSpecificLogger.html)) and must have a public no-argument constructor - failing to declare one will result in a compilation error - and must pass the type they log to the superclass constructor.
 
 .. note:: Only one custom logger may be defined for a single type. Custom loggers will only be detected and used if they are defined in the robot project; custom loggers defined in third-party libraries cannot be detected.
 
diff --git a/source/docs/software/wpilib-tools/outlineviewer/index.rst b/source/docs/software/wpilib-tools/outlineviewer/index.rst
@@ -6,7 +6,7 @@ OutlineViewer is a utility used to view, modify and add to the contents of the N
 
 In Visual Studio Code, press :kbd:`Ctrl+Shift+P` and type ``WPILib`` or click the WPILib logo in the top right to launch the WPILib Command Palette. Select :guilabel:`Start Tool`, then select :guilabel:`OutlineViewer`.
 
-To connect to your robot, open OutlineViewer and slect :guilabel:`options` then :guilabel:`settings` and set the ``Team/IP`` to be your team number. After you click :guilabel:`Apply`, OutlineViewer will connect.  If you have trouble connecting to OutlineViewer please see the :doc:`Dashboard Troubleshooting Steps </docs/software/dashboards/troubleshooting-dashboard-connectivity>`.
+To connect to your robot, open OutlineViewer and select :guilabel:`options` then :guilabel:`settings` and set the ``Team/IP`` to be your team number. After you click :guilabel:`Apply`, OutlineViewer will connect.  If you have trouble connecting to OutlineViewer please see the :doc:`Dashboard Troubleshooting Steps </docs/software/dashboards/troubleshooting-dashboard-connectivity>`.
 
 .. note:: You can use ``localhost`` instead of a team number to point OutlineViewer at a simulated robot, Romi or XRP.
 
diff --git a/source/docs/software/wpilib-tools/roborio-team-number-setter/index.rst b/source/docs/software/wpilib-tools/roborio-team-number-setter/index.rst
@@ -15,7 +15,7 @@ Enter your team number in the :guilabel:`Team Number` field and select :guilabel
 
 ## Enabling/Disabling Webserver
 
-The :doc:`roboRIO's webserver </docs/software/roborio-info/roborio-web-dashboard>` provides some debuging and enables some configuration. However, it also takes memory away from the robot program. You can disable it by clicking on the :guilabel:`Disable Web Server` button. If you'd like to enable it again, you can click :guilabel:`Enable Web Server`.
+The :doc:`roboRIO's webserver </docs/software/roborio-info/roborio-web-dashboard>` provides some debugging and enables some configuration. However, it also takes memory away from the robot program. You can disable it by clicking on the :guilabel:`Disable Web Server` button. If you'd like to enable it again, you can click :guilabel:`Enable Web Server`.
 
 ## roboRIO Identification
 
diff --git a/source/docs/yearly-overview/known-issues.rst b/source/docs/yearly-overview/known-issues.rst
diff --git a/source/docs/yearly-overview/yearly-changelog.rst b/source/docs/yearly-overview/yearly-changelog.rst
