Skip to content

Conversation

hamishwillee
Copy link
Contributor

@hamishwillee hamishwillee commented May 15, 2025

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.

@hamishwillee hamishwillee requested a review from sfuhrer May 15, 2025 04:32
@hamishwillee
Copy link
Contributor Author

hamishwillee commented May 15, 2025

@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 # is the same.

IF necessary I can redo this in separate commits to prove this.

@mrpollo
Copy link
Contributor

mrpollo commented May 16, 2025

My two cents: We should bump the version regardless, since this is a change irrespective of whether fields/values are the same as before.

@bkueng @sfuhrer any thoughts?

@hamishwillee
Copy link
Contributor Author

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.

@hamishwillee hamishwillee force-pushed the hamishwillee-vehicle_command_updatetwo branch from 405bc7b to edbbfb0 Compare May 21, 2025 03:43
@hamishwillee
Copy link
Contributor Author

My two cents: We should bump the version regardless, since this is a change irrespective of whether fields/values are the same as before.

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.
Unless it will cause an ongoing break/fail in tests?

Can we merge this as is? @mrpollo @bkueng

@bkueng
Copy link
Member

bkueng commented May 21, 2025

The CI failure is a false positive - the version check didn't ignore whitespace. I pushed a fix in aa9809c.

@hamishwillee hamishwillee force-pushed the hamishwillee-vehicle_command_updatetwo branch from aa9809c to a512884 Compare May 22, 2025 02:31
@hamishwillee
Copy link
Contributor Author

Thanks @bkueng - passing the tests now.

@sfuhrer Can you review. This doesn't have semantic changes - its just updating existing docs to the patterns we agreed for documenting stuff. There is lots more to be done to complete it.

Copy link
Contributor

@sfuhrer sfuhrer left a 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?

@hamishwillee
Copy link
Contributor Author

@sfuhrer Sure - but doesn't "Squash and merge" do that for you?

@hamishwillee hamishwillee force-pushed the hamishwillee-vehicle_command_updatetwo branch from a512884 to 8c24a1d Compare May 22, 2025 22:46
@sfuhrer
Copy link
Contributor

sfuhrer commented May 23, 2025

@sfuhrer Sure - but doesn't "Squash and merge" do that for you?

Yes, but I meant to keep Beat's commit about the CI change separate of the vehiclecommand update.
image

@hamishwillee
Copy link
Contributor Author

Unfortunately I don't know how to unsquish that now.

@hamishwillee hamishwillee merged commit b4b3c2a into main May 24, 2025
69 checks passed
@hamishwillee hamishwillee deleted the hamishwillee-vehicle_command_updatetwo branch May 24, 2025 06:03
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.

4 participants