Skip to content

More readable YAML syntax#213

Merged
paddyroddy merged 7 commits intomainfrom
yaml-syntax
Oct 30, 2023
Merged

More readable YAML syntax#213
paddyroddy merged 7 commits intomainfrom
yaml-syntax

Conversation

@paddyroddy
Copy link
Member

@paddyroddy paddyroddy commented Oct 26, 2023

Suggestion to split up #207. To be merged after #210, #212.

@paddyroddy paddyroddy self-assigned this Oct 26, 2023
Copy link
Member

@samcunliffe samcunliffe left a comment

Choose a reason for hiding this comment

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

🤷 Meh.

I'm fine with this, but I actually find the single-line list more readable.

Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

Yeah, I also find the single line (before) more readable

@dstansby
Copy link
Member

So unless there are others with a strong preference for this PR, I'd suggest we don't merge?

@paddyroddy
Copy link
Member Author

Think beyond the one line case.

In this example I find this a lot more readable than the alternative of ["--exclude", ".github", "--warn-list", "yaml[indentation]" - bearing in mind that each of these can be a list. I want to use this format as I believe it's more extendable, and the = make it really obvious that arg2 is tied to arg1
https://github.com/UCL-MIRSG/.github/blob/de59482693728701ceb43ad8f8f9ca4b03c26bc2/precommit/mirsg-hooks.yaml#L32-L38

@paddyroddy paddyroddy merged commit 2454144 into main Oct 30, 2023
@paddyroddy paddyroddy deleted the yaml-syntax branch October 30, 2023 18:57
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