Fix typos (#814)

Co-authored-by: shueja <[email protected]>
SleipnirGroup · Oct 2, 2024 · db37cf6 · db37cf6
1 parent e85a121
commit db37cf6
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/choreolib/src/main/java/choreo/auto/AutoFactory.java b/choreolib/src/main/java/choreo/auto/AutoFactory.java
@@ -271,7 +271,7 @@ public <SampleType extends TrajectorySample<SampleType>> AutoTrajectory trajecto
    *
    * <p>{@link #trajectoryCommand} and {@link #trajectory} methods should not be mixed in the same
    * auto routine. {@link #trajectoryCommand} is used as an escape hatch for teams that don't need
-   * the benefits of the {@link #trajectory} method and its {@link Trigger} api. {@link
+   * the benefits of the {@link #trajectory} method and its {@link Trigger} API. {@link
    * #trajectoryCommand} does not invoke bindings added via calling {@link #bind} or {@link
    * ChoreoAutoBindings} passed into the factory constructor.
    *
@@ -289,7 +289,7 @@ public Command trajectoryCommand(String trajectoryName) {
    *
    * <p>{@link #trajectoryCommand} and {@link #trajectory} methods should not be mixed in the same
    * auto routine. {@link #trajectoryCommand} is used as an escape hatch for teams that don't need
-   * the benefits of the {@link #trajectory} method and its {@link Trigger} api. {@link
+   * the benefits of the {@link #trajectory} method and its {@link Trigger} API. {@link
    * #trajectoryCommand} does not invoke bindings added via calling {@link #bind} or {@link
    * ChoreoAutoBindings} passed into the factory constructor.
    *
@@ -308,7 +308,7 @@ public Command trajectoryCommand(String trajectoryName, final int splitIndex) {
    *
    * <p>{@link #trajectoryCommand} and {@link #trajectory} methods should not be mixed in the same
    * auto routine. {@link #trajectoryCommand} is used as an escape hatch for teams that don't need
-   * the benefits of the {@link #trajectory} method and its {@link Trigger} api. {@link
+   * the benefits of the {@link #trajectory} method and its {@link Trigger} API. {@link
    * #trajectoryCommand} does not invoke bindings added via calling {@link #bind} or {@link
    * ChoreoAutoBindings} passed into the factory constructor.
    *

diff --git a/choreolib/src/main/java/choreo/util/AllianceFlipUtil.java b/choreolib/src/main/java/choreo/util/AllianceFlipUtil.java
@@ -19,7 +19,7 @@
  * <p>If every vendor used this, the user would be able to specify the year and no matter the year
  * the vendor's code is from, the user would be able to flip as expected.
  *
- * <p>This api still allows vendors and users to match case against the flipping variant as a way to
+ * <p>This API still allows vendors and users to match case against the flipping variant as a way to
  * specially handle cases or throw errors if a variant is explicitly not supported.
  */
 public class AllianceFlipUtil {

diff --git a/choreolib/src/test/java/choreo/Examples.java.fake b/choreolib/src/test/java/choreo/Examples.java.fake
@@ -220,7 +220,7 @@ public class Examples {
             new ConditionalCommand(
                 deadline(m1ToS1, aim()).andThen(shootIfGp()),
                 deadline(m1ToM2, intake()).andThen(deadline(m2ToS1, aim()), shootIfGp()),
-                yeGp() // if you arent using the triggers api these wouldnt need a custom loop
+                yeGp() // if you aren't using the triggers API these wouldn't need a custom loop
                 ),
             deadline(s1ToC2, intake(), aim()),
             shootIfGp(),

diff --git a/docs/choreolib/auto-routines.md b/docs/choreolib/auto-routines.md
@@ -1,6 +1,6 @@
 # Auto Routines
 
-Choreolib provides a higher level api to make it easier to create competitive and complex auto routines inside your robot code.
+Choreolib provides a higher level API to make it easier to create competitive and complex auto routines inside your robot code.
 This is done by providing the `AutoFactory` class.
 
 ## Triggers vs Composition
@@ -227,7 +227,7 @@ public Command fivePieceAutoCompositionSeg(AutoFactory factory) {
           new ConditionalCommand(
               deadline(m1ToS1, aim()).andThen(shootIfGp()),
               deadline(m1ToM2, intake()).andThen(deadline(m2ToS1, aim()), shootIfGp()),
-              yeGp() // if you arent using the triggers api these wouldnt need a custom loop
+              yeGp() // if you aren't using the triggers API these wouldn't need a custom loop
               ),
           deadline(s1ToC2, intake(), aim()),
           shootIfGp(),

diff --git a/docs/choreolib/lowlevel-usage.md b/docs/choreolib/lowlevel-usage.md
@@ -2,7 +2,7 @@
 
 Choreolib aims to support a wide range of use cases.
 Many teams like to use their own path following structure and this was somewhat encouraged in 2023.
-To not leave these teams behind, Choreolib provides a lower level api that allows you to directly load trajectories
+To not leave these teams behind, Choreolib provides a lower level API that allows you to directly load trajectories
 and use them in your own path following code.
 
 ``` { .java .select }

diff --git a/src-core/src/lib.rs b/src-core/src/lib.rs
@@ -23,9 +23,9 @@ mod error;
 
 pub use error::ChoreoError;
 
-/// The api for managing choreo files.
+/// The API for managing choreo files.
 pub mod file_management;
-/// The api for generating trajectories.
+/// The API for generating trajectories.
 pub mod generation;
 /// An implementation of the `Choreo Document Specification`.
 pub mod spec;