search

moveit / moveit_resources

URDFs, meshes, and config packages for MoveIt testing
61 stars 114 forks source link

Remove comments from scalars #169

Closed stephanie-eng closed 1 year ago

stephanie-eng commented 1 year ago

The YAML specification does not support comments inside scalars, such as the one used to specify request_adapters. These lines will not be interpreted correctly. This PR moves the comments outside of the scalar such that they are properly interpreted as comments.

I wrote this script to check the repo for all potential issues of this nature and fixed the three that it found.

stephanie-eng commented 1 year ago

Mostly by luck, really. I just decided to start from a clean workspace and pulled all dependencies + rebuilt MoveIt today.

simonschmeisser commented 1 year ago

There is check yaml running as part of pre-commit-ci, why does it not catch this problem? Maybe you could open an issue with them?

rhaschke commented 1 year ago

There is check yaml running as part of pre-commit-ci, why does it not catch this problem?

The syntax is OK, but semantically, the comment becomes part of the scalar text value, which is not intended here. Hence, the linter works fine. It can not know about our semantic intention.