Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write docstrings for constants #7

Open
Ishan1522 opened this issue Oct 29, 2024 · 0 comments
Open

Write docstrings for constants #7

Ishan1522 opened this issue Oct 29, 2024 · 0 comments
Assignees
Labels
minion task a task dedicated to a minion

Comments

@Ishan1522
Copy link
Member

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;
   }
@Ishan1522 Ishan1522 added the minion task a task dedicated to a minion label Nov 3, 2024
@junocapra junocapra self-assigned this Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minion task a task dedicated to a minion
Projects
None yet
Development

No branches or pull requests

2 participants