Skip to content

Write docstrings for constants #7

@Ishan1522

Description

@Ishan1522

Example shown here. Credit to @JacksonElia

  /**
    * This is where we place constants related to hardware on a robot that aren't
    * specific to any singular subsystem.
    */
   public static final class HardwareConstants {
     public static final double TIMEOUT_S = 0.02;

     public static final String CANIVORE_CAN_BUS_STRING = "canivore 1";
     public static final String RIO_CAN_BUS_STRING = "rio";

     /**
      * For some reason, falcons normally have a deadband threshold of 4%. This is
      * incredibly high! It makes it very hard to do precise movements, so with this
      * constant we set the threshold to the lowest possible value.
      */
     public static final double MIN_FALCON_DEADBAND = 0.001;
   }

Metadata

Metadata

Assignees

Labels

minion taska task dedicated to a minion

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions