-
Notifications
You must be signed in to change notification settings - Fork 14.6k
VehicleCommand.msg - update existing to docs standard #24855
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
Conversation
@sfuhrer I think the error in CI is invalid - I certainly did not intend to modify the content of the message. Do you know if this check looks for modifications to fields etc, or is just looking at any file changes? If the later this is probably invalid - I can't see anything actually changed - as far as I can tell everything before the IF necessary I can redo this in separate commits to prove this. |
I still need know if the checker spots any change or meaningful changes. Because if it captures meaningful changes only, then that means I need to start again since this was only supposed to change the docs. |
405bc7b
to
edbbfb0
Compare
OK, I very carefully did this again in #24890 in parts, and then copied the result here. Essentially showed that what triggers that the tests fail do not have to be a semantic change - what triggers it seems quite arbitrary. I trust this change and I don't think we should bump the version unless there is a "real change". Because if I have to do this just to tidy up docs it is not worth my time vs other things I might be doing. |
The CI failure is a false positive - the version check didn't ignore whitespace. I pushed a fix in aa9809c. |
aa9809c
to
a512884
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find no errors, looks clean.
@hamishwillee can you clean up the commits before merging?
@sfuhrer Sure - but doesn't "Squash and merge" do that for you? |
a512884
to
8c24a1d
Compare
Yes, but I meant to keep Beat's commit about the CI change separate of the vehiclecommand update. |
Unfortunately I don't know how to unsquish that now. |
This updates the docs in VehicleMessage uorb topic to match our current docs standard, as discussed in #24574 (review) . There is no semantic change - merging this should change nothing.
But, when we start fixing things, it should be easier to see the changes.
NOTE, it primarily updates the existing docs. I haven't tried to add anything to this.