Skip to content

Fix typo in IdealStartingState Javadoc (#1007) #1008

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.

Sign up for GitHub

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

Merged
mjansen4857 merged 2 commits into from
Jan 16, 2025
Merged

Fix typo in IdealStartingState Javadoc (#1007) #1008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0bb09d
Fix typo in IdealStartingState Javadoc (#1007)
codydg Jan 15, 2025
26ed017
Fix typo in IdealStartingState's Python Documentation (#1007)
codydg Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pathplannerlib-python/pathplannerlib/path.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ def __eq__(self, other):
@dataclass(frozen=True)
class IdealStartingState:
"""
Describes the ideal starting state of the robot when finishing a path
Describes the ideal starting state of the robot when starting a path

Args:
velocity (float): The ideal starting velocity (M/S)
Expand Down
4 changes: 2 additions & 2 deletions pathplannerlib/src/main/java/com/pathplanner/lib/path/IdealStartingState.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
import org.json.simple.JSONObject;

/**
* Describes the ideal starting state of the robot when finishing a path
* Describes the ideal starting state of the robot when starting a path
*
* @param velocityMPS The ideal starting velocity (M/S)
* @param rotation The ideal starting rotation
*/
public record IdealStartingState(double velocityMPS, Rotation2d rotation) {
/**
* Describes the ideal starting state of the robot when finishing a path
* Describes the ideal starting state of the robot when starting a path
*
* @param velocity The ideal starting velocity
* @param rotation The ideal starting rotation
Expand Down
Loading