Skip to content

Update comments in VehicleCommands #25

@audrow

Description

@audrow

It seems that the comments in https://github.com/PX4/px4_msgs/blob/main/msg/VehicleCommand.msg have fallen out of sync with the messages being used. Maybe the comments could be updated, or if not deleted (especially the incorrect information).

For example, the comments with VEHICLE_CMD_DO_SET_MODE say that it takes only one argument,
https://github.com/PX4/px4_msgs/blob/main/msg/VehicleCommand.msg#L32

But the command on Mavlink takes up to three parameters.

https://mavlink.io/en/messages/common.html#MAV_CMD_NAV_LAND

Also, some comments list the inputs for the command. In the case that no inputs are listed, I assume that the command takes no parameters, but this is not true in every case. For example,

https://github.com/PX4/px4_msgs/blob/main/msg/VehicleCommand.msg#L32

Has two arguments documented here:

https://mavlink.io/en/messages/common.html#MAV_CMD_DO_VTOL_TRANSITION

I assume that these examples are not the only errors or possibly confusing comments. It may be good to direct users to the documentation or source code, instead of keeping the comments up-to-date.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions