Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix flow-map syntax of rosdoc2.yaml #93

Merged
merged 1 commit into from
Jul 22, 2024

Conversation

christophfroehlich
Copy link
Contributor

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
Copy link
Contributor

rkent commented Apr 9, 2024

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
Copy link
Contributor Author

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
Copy link
Member

tfoote commented Apr 14, 2024

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.

Copy link
Member

@tfoote tfoote left a comment

Choose a reason for hiding this comment

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

Thanks for iterating and cleaning this up.

@tfoote tfoote merged commit b3803c5 into ros-infrastructure:main Jul 22, 2024
2 checks passed
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