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

Fix clang-tidy in CI, add further documentation #18

Merged
merged 7 commits into from
Feb 18, 2025

Conversation

henrygerardmoore
Copy link
Collaborator

@henrygerardmoore henrygerardmoore commented Feb 14, 2025

This fixes clang-tidy by setting the C++ std (since the default on ubuntu 20.04 is not C++ 17).

Additionally, I add the skeleton of lots of docs.

Finally, this adds a proper docs page for the transform sensor.

Reviewing instructions

Mostly just see that CI is ✔️ and read through transform_sensor.md for content and clarity. The docs skeleton is just there to make adding them easier and more standardized, so as to encourage it. The changes to unicycle_2d_ignition were just to make clang-tidy have a cpp file to run on (since at the moment it'll only run on changed cpp/hpp files).

@henrygerardmoore henrygerardmoore marked this pull request as ready for review February 14, 2025 23:38
Copy link
Collaborator

@marioprats marioprats left a comment

Choose a reason for hiding this comment

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

Looks good!
Q: can the transform sensor be used to estimate the odometry of a body, when that body is moving and the AR tags are fixed?
I'm thinking that's probably a more common example, e.g. fixed AR tags on walls and a robot moving and estimating motion based on those AR tags.

@henrygerardmoore
Copy link
Collaborator Author

Looks good! Q: can the transform sensor be used to estimate the odometry of a body, when that body is moving and the AR tags are fixed? I'm thinking that's probably a more common example, e.g. fixed AR tags on walls and a robot moving and estimating motion based on those AR tags.

I don't think so without modifications. This would require knowing the transform from the current estimation frame to the robot CoM, which we currently don't have a way to get. To modify this sensor to be able to do that, though, wouldn't be too hard at all.

@henrygerardmoore
Copy link
Collaborator Author

Just pushed a change that will make clang-tidy fail but applies the new clang-format to everything. I'm going to leave clang-tidy failing because I want to fix things incrementally instead of all at once, but the clang-format changes make it run on all the cpp and hpp files.

@henrygerardmoore henrygerardmoore merged commit 1556ad6 into humble Feb 18, 2025
3 of 4 checks passed
@henrygerardmoore henrygerardmoore deleted the fix_ci_add_docs branch February 18, 2025 19:23
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