search

ros-infrastructure / rosdoc2

Command-line tool for generating documentation for ROS 2 packages.
Apache License 2.0
29 stars 9 forks source link

Fix flow-map syntax of rosdoc2.yaml #93

Open christophfroehlich opened 2 months ago

christophfroehlich commented 2 months ago

There are some issues with the yaml syntax of the default config.

I created a default rosdoc2.yaml with rosdoc2 default_config --package-path src/realtime_tools/, but the linter complains

Flow map in block collection must be sufficiently indented and end with a }YAML
Unexpected flow-map-end token in YAML stream: "}"YAML

Increasing the indent fixes this for me.

rkent commented 2 months ago

I don't understand why the test failed, it passes locally for me. Looks to me like some sort of unrelated one-time system glitch.

I did not see any specification of yaml style in the ros code style specification. Is there a ros standard yaml linter? I am not aware of any. What linter did you use?

The proposed change seems harmless, and does conform to most examples I have seen of yaml, but I am by no means an expert on yaml code style or syntax.

christophfroehlich commented 2 months ago

I refer to the redhat.vscode-yaml extension. I don't know how strict the specification is, or if different linters can have different interpretations.

tfoote commented 2 months ago

CI was broken due to the noble upgrade under the hood. It was fixed in #96 can you rebase? I'm not sure if we have a formal linter formatting. I think we typically use the default output from the python library.