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 whitespace consistency in config.md #945

Merged
merged 1 commit into from
Sep 22, 2022

Conversation

tianon
Copy link
Member

@tianon tianon commented Sep 6, 2022

Some of the sub-items of config were inconsistently indented (some using three spaces, some using two) -- adjusted to two to match the rest of the file.

*Some* of the sub-items of `config` were inconsistently indented (some using three spaces, some using two) -- adjusted to two to match the rest of the file.

Signed-off-by: Tianon Gravi <admwiggin@gmail.com>
@tianon
Copy link
Member Author

tianon commented Sep 6, 2022

I was looking at why https://specs.opencontainers.org/image-spec/config/?v=v1.0.1#properties is rendering the sub-items of config as being even with it instead, and noticed this inconsistency. I'm not 100% sure which engine that's using to render (or how to most effectively test it), but IMO this seems like a sane change even if it's not the cause of that rendering glitch. 😅

@tianon
Copy link
Member Author

tianon commented Sep 6, 2022

The CI-generated PDF renders correctly, for what that's worth!

image

(It was probably fine with the janky whitespace too, though)

Copy link
Contributor

@sudo-bmitch sudo-bmitch left a comment

Choose a reason for hiding this comment

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

LGTM. Children of rootfs and history should also be adjusted to 2 spaces for consistency. And the bold and italic markup also needs work. But those can all be a separate PR, especially since it needs to happen in other files, too. I've got on my list to add a markdown linter here after doing a cleanup.

Copy link
Member

@vbatts vbatts left a comment

Choose a reason for hiding this comment

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

🧁

@vbatts vbatts merged commit 199b07a into opencontainers:main Sep 22, 2022
@tianon tianon deleted the whitespace-consistency branch September 22, 2022 15:13
@sajayantony sajayantony mentioned this pull request Sep 26, 2022
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