Changes documentation for removeMotorIfFaulty/removeFaultyMotor

Author: GrayHoang

src/software/embedded/services/motor.cpp

@@ -114,7 +114,7 @@ void MotorService::MotorFaultIndicator::update(
     }
 }
 
-void MotorService::MotorFaultIndicator::removeFaultyMotor(std::set<uint8_t>& motors)
+void MotorService::MotorFaultIndicator::removeMotorIfFaulty(std::set<uint8_t>& motors)
 {
     if (num_critical_faults > MOTOR_FAULT_THRESHOLD_COUNT)
     {
@@ -359,7 +359,7 @@ void MotorService::checkDriverFault(uint8_t motor)
     }
 
     cached_motor_faults_.at(motor).update(drive_enabled, motor_faults);
-    cached_motor_faults_.at(motor).removeFaultyMotor(enabled_motors);
+    cached_motor_faults_.at(motor).removeMotorIfFaulty(enabled_motors);
 }
 
 TbotsProto::MotorStatus MotorService::updateMotorStatus(double front_left_velocity_mps,

src/software/embedded/services/motor.h

@@ -153,12 +153,12 @@ class MotorService
                     std::unordered_set<TbotsProto::MotorFault>& motor_faults);
 
         /**
-         *  Remove motor_id from enabled_motors and log the removal, if it has failed too
-         * much.
+         *  If a motor has failed repeatedly, remove the associated motor_id
+         *  from enabled_motors and log the removal.
          *
-         *  @param motors a set of motors that are currently enabled
+         *  @param motors a set of motors that are currently enabled. May be modified by this function.
          */
-        void removeFaultyMotor(std::set<uint8_t>& motors);
+        void removeMotorIfFaulty(std::set<uint8_t>& motors);
     };
 
     /**