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

Style guide proposal: defensively quote _all_ YAML strings #878

Open
mfisher87 opened this issue Nov 8, 2024 · 1 comment
Open

Style guide proposal: defensively quote _all_ YAML strings #878

mfisher87 opened this issue Nov 8, 2024 · 1 comment
Labels
impact: documentation Improvements or additions to documentation

Comments

@mfisher87
Copy link
Collaborator

It doesn't matter how long you've been using YAML and how aware of its pitfalls you are. This kind of thing will eventually bite you as it did me today: https://github.com/nsidc/earthaccess/actions/runs/11747889420/job/32730773288?pr=876

This happened because I changed the value of a YAML field from 3.9 -> 3.10. This evaluates to 3.1 because YAML has more pitfalls than one can reasonably memorize. The correct change was 3.9 -> "3.10". IMO, we should be defensively quoting all of our strings.

@mfisher87 mfisher87 added the impact: documentation Improvements or additions to documentation label Nov 8, 2024
@jhkennedy
Copy link
Collaborator

jhkennedy commented Nov 8, 2024

Big 🤷 from me -- I think it reads better without quotes and I'm lazy so don't want to type them 🤣 , but that will bite you occasionally. I'm fine with adopting that as the style here though if there's quarum. There's not really a good reason not to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact: documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants