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

Commenting for documentation and fixing up drive.hpp #218

Merged
merged 3 commits into from
Dec 11, 2024

Conversation

jemminiz
Copy link
Contributor

@jemminiz jemminiz commented Dec 9, 2024

Summary:

I fixed up the documentation through drive.hpp because I felt that it was lackluster and could be improved.

Motivation:

This allows teams to more easily understand what their code is doing.

References (optional):

Test Plan:

Talk to newer teams and see how they prefer these comments to the old ones, if necessary.

  • test item

Download the template for this pull request:

Note

This is auto generated from Add Template to Pull Request

curl -o [email protected]+3d23b0.zip https://nightly.link/EZ-Robotics/EZ-Template/actions/artifacts/2299668835.zip;
pros c fetch [email protected]+3d23b0.zip;
pros c apply [email protected]+3d23b0;
rm [email protected]+3d23b0.zip;

@jemminiz
Copy link
Contributor Author

Build failed because I did a silly. Removed parameter e_angle_behavior for a getter that I didn't remove in the .cpp file. Rebuilding now, will update once all good

@jemminiz
Copy link
Contributor Author

Build passed, should be good to go!

@jemminiz jemminiz changed the title Commenting for documentation Commenting for documentation and fixing up drive.hpp Dec 10, 2024
@ssejrog ssejrog merged commit 4ad240a into EZ-Robotics:dev Dec 11, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants