Skip to content

Commit

Permalink
Show a warning regarding loading autos when code starts (#650)
Browse files Browse the repository at this point in the history
  • Loading branch information
mjansen4857 authored Mar 17, 2024
1 parent 8c54239 commit d177e93
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
1 change: 1 addition & 0 deletions Writerside/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<algolia-index>PathPlanner_docs</algolia-index>
<algolia-api-key>06b58ff141ea245f0a9e57fd77682f3f</algolia-api-key>
<web-root>https://pathplanner.dev</web-root>
<product-web-url>https://pathplanner.dev</product-web-url>
</variables>

<build-profile instance="hi">
Expand Down
13 changes: 12 additions & 1 deletion Writerside/topics/pplib-Build-an-Auto.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,16 @@ class DriveSubsystem(Subsystem):
After you have configured the AutoBuilder, creating an auto is as simple as constructing a `PathPlannerAuto` with the
name of the auto you made in the GUI.

> **Warning**
>
> It is highly recommended to create all of your autos when code starts, instead of creating them when you want to run
> them. Large delays can happen when loading complex autos/paths, so it is best to load them before they are needed.
>
> In the interest of simplicity, this example will show an auto being loaded in the `getAutonomousCommand` function,
> which is called when auto is enabled. This is not the recommended way to load your autos.
>
{style="warning"}

<tabs group="pplib-language">
<tab title="Java" group-key="java">

Expand Down Expand Up @@ -442,7 +452,8 @@ every auto in the project.
> **Warning**
>
> This method will load all autos in the deploy directory. Since the deploy process does not automatically clear the
> deploy directory, old auto files that have since been deleted from the project could remain on the RIO, therefore being
> deploy directory, old auto files that have since been deleted from the project could remain on the RIO, therefore
> being
> added to the auto chooser.
>
> To remove old options, the deploy directory will need to be cleared manually via SSH, WinSCP, reimaging the RIO, etc.
Expand Down

0 comments on commit d177e93

Please sign in to comment.