Skip to content

Commit

Permalink
Update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
AceiusRedshift committed Mar 5, 2024
1 parent fa3e407 commit faf008f
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion src/main/java/frc/robot/commands/AimAtTag.java
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public AimAtTag(SwerveDrivetrain drivetrain, Vision vision, int tagID, ChassisDr
*
* @param drivetrain the drivetrain of the robot
* @param vision the vision subsystem of the robot
* @param tagID the numerical ID of the the tag to turn to, null for best
* @param tagID the numerical ID of the tag to turn to, null for best
* tag
*/
public AimAtTag(SwerveDrivetrain drivetrain, Vision vision, Integer tagID) {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/frc/robot/subsystems/ExampleSubsystem.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

// How to make Subsystem: https://compendium.readthedocs.io/en/latest/tasks/subsystems/subsystems.html (ignore image instructions, code is out of date, just look at written general instructions)
// Command based programming: https://docs.wpilib.org/en/stable/docs/software/commandbased/what-is-command-based.html
// Subsystem Documentation documentation: https://docs.wpilib.org/en/stable/docs/software/commandbased/subsystems.html
// Subsystem Documentation: https://docs.wpilib.org/en/stable/docs/software/commandbased/subsystems.html

public class ExampleSubsystem extends SubsystemBase {
/** Constructor. Creates a new ExampleSubsystem. */
Expand All @@ -15,7 +15,7 @@ public ExampleSubsystem() {
/**
* This method is called periodically by the CommandScheduler, about every 20ms.
* It should be used for updating subsystem-specific state that you don't want to offload to a Command.
* Try to avoid "doing to much" in this method (for example no driver control here).
* Try to avoid "doing too much" in this method (for example no driver control here).
*/
@Override
public void periodic() {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/frc/robot/subsystems/SwerveDrivetrain.java
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public class SwerveDrivetrain extends SubsystemBase {

/**
* The SwerveDriveOdometry class can be used to track the position of a swerve drive robot on the field
*
*
* @see https://docs.wpilib.org/en/stable/docs/software/kinematics-and-odometry/swerve-drive-odometry.html
*/
private final SwerveDriveOdometry poseOdometry;
Expand Down Expand Up @@ -421,7 +421,7 @@ private void modulesMap(Consumer<SwerveModule> func) {

/**
* Utility method. Function to easily run a function on each swerve module and collect results to array.
* Insures that we don't mix up order of swerve modules, as this could lead to hard to spot bugs.
* Insures that we don't mix up order of swerve modules, as this could lead to hard-to-spot bugs.
*
* @param <T> type that is returned by function and should be collected
* @param func function that gets some data off each swerve module
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/frc/robot/subsystems/SwerveModule.java
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public SwerveModule(int driveMotorDeviceId, int steeringMotorDeviceId, int steer
// --- Drive Motor ---
driveMotor = new CANSparkMax(driveMotorDeviceId, MotorType.kBrushless);

// You most restore factory defaults if you want to use velocity encoder.
// You must restore factory defaults if you want to use velocity encoder.
// If you do not do this, everything will break and shake itself to death
driveMotor.restoreFactoryDefaults();

Expand Down

0 comments on commit faf008f

Please sign in to comment.