Skip to content

Conversation

hamishwillee
Copy link
Contributor

This fixes up the ActuatorMotors UORB topic to match the evolving doc standard (for similar, see #24662 , #24789).

Solution

  • Single space for comments etc
  • Sentence capitalize comments
  • Enum values after the field that uses them
  • Uses the following markup
    • [<value>] to mark units
    • [@enum <value>] to mark allowed values
    • [@range <minValue>,<maxValue>] to mark ranges - inclusive
    • [@invalid <value>] to mark the invalid/not-supplied value

Changelog Entry

For release notes:

Fix actuator_motor message definition

Other comments

See inline notes

@hamishwillee hamishwillee requested a review from MaEtUgR May 8, 2025 03:53
uint16 reversible_flags # bitset which motors are configured to be reversible
uint16 reversible_flags # Bitset indicating which motors are configured to be reversible

uint8 ACTUATOR_FUNCTION_MOTOR1 = 101
Copy link
Contributor Author

Choose a reason for hiding this comment

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

What is this and where is it used?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@MaEtUgR ^^^ This still looks weird. Needs explanation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But if not, let's still merge!

Copy link
Member

@MaEtUgR MaEtUgR left a comment

Choose a reason for hiding this comment

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

Makes sense, I added some ideas.

@hamishwillee hamishwillee requested a review from MaEtUgR May 14, 2025 03:55
@hamishwillee
Copy link
Contributor Author

@MaEtUgR I think ready for another look. The question in #24818 (comment) is still open.

@hamishwillee hamishwillee force-pushed the hamishwillee-actuator_motors branch from 63e19a5 to 635c360 Compare June 12, 2025 01:35
@hamishwillee
Copy link
Contributor Author

I am self merging. It matches our standard, and doesn't change anything else. So it is no worse than before, and a bit better.

@hamishwillee hamishwillee merged commit a9e67d4 into main Jun 12, 2025
68 of 69 checks passed
@hamishwillee hamishwillee deleted the hamishwillee-actuator_motors branch June 12, 2025 08:45
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.

3 participants