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.

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

Jump to bottom

[simulation] Document zero angle in SingleJointedArmSim #7756

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

[simulation] Document zero angle in SingleJointedArmSim #7756

wants to merge 5 commits into from
+24 −12

Conversation

DeltaDizzy
Copy link
Contributor

Fixes #7752

@DeltaDizzy DeltaDizzy requested a review from a team as a code owner January 31, 2025 17:00
calcmogul
calcmogul requested changes Jan 31, 2025
View reviewed changes
Copy link
Member

@calcmogul calcmogul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a lot of unrelated changes here. This should only be about a 12-line diff.

@DeltaDizzy
Copy link
Contributor Author

There's a lot of unrelated changes here. This should only be about a 12-line diff.

The formatting checks fail otherwise, though i guess i can try and make it only correct that line...

@calcmogul
Copy link
Member

calcmogul commented Jan 31, 2025 •
edited
Loading

I don't get why CI would want them changed; it was fine before. We pin the formatter versions too.

@DeltaDizzy
Copy link
Contributor Author

I don't get why CI would want them changed; it was fine before. We pin the formatter versions too.

Line length >100 characters (because of the added information) is what tripped it.

@auscompgeek auscompgeek added os: simulation type: docs Related to documentation and information. labels Jan 31, 2025
PeterJohnson
PeterJohnson requested changes Feb 1, 2025
View reviewed changes
wpilibc/src/main/native/include/frc/simulation/SingleJointedArmSim.h
* @param minAngle The minimum angle that the arm is capable of.
* @param maxAngle The maximum angle that the arm is capable of.
* @param minAngle The minimum angle that the arm is capable of,
* with 0 being horizontal.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with the rest of the comments, the overflowed text should be aligned (e.g. see the doc for the gearing parameter).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PeterJohnson PeterJohnson PeterJohnson requested changes

@calcmogul calcmogul calcmogul approved these changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
component: wpilibc WPILib C++ component: wpilibj WPILib Java os: simulation type: docs Related to documentation and information.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document zero angle for SingleJointedArmSim
4 participants
@DeltaDizzy @calcmogul @PeterJohnson @auscompgeek