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 low hanging yamllint errors/warnings #38

Merged
merged 2 commits into from
Feb 12, 2025
Merged

Conversation

LeSpocky
Copy link
Contributor

After copying the example for using in my own project I noticed some yamllint warnings. While fixing this in my project is nice, I thought others could benefit when copying yaml snippets with less warnings.

Fixes the following yamllint warning:

      5:1       warning  missing document start "---"  (document-start)
This avoid copying this flaws from the examples to every user including
this in his or her actions.

After extracting from the code block to a separate file:

    % yamllint example1.yaml
    example1.yaml
      1:81      error    line too long (86 > 80 characters)  (line-length)
      5:1       warning  missing document start "---"  (document-start)
      7:1       warning  truthy value should be one of [false, true]  (truthy)
      16:5      error    wrong indentation: expected 6 but found 4  (indentation)

Ignoring the "line too long" and the "truthy value" issue, but "missing
document start" and "wrong indentation" could be fixed easily.
Copy link
Member

@mxmehl mxmehl left a comment

Choose a reason for hiding this comment

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

Thank you, LGTM :)

@mxmehl mxmehl merged commit 211d270 into fsfe:main Feb 12, 2025
6 checks passed
@LeSpocky LeSpocky deleted the yamllint branch February 12, 2025 11:31
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.

2 participants