Give context about how many spaces were expected #722
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adrienverge
reviewed
Mar 21, 2025
Owner
adrienverge
left a comment
adrienverge
left a comment
There was a problem hiding this comment.
Hello, thanks for contributing!
It looks like the linter reported a line too long: can you check that?
When it's ready please squash everything into one commit (to be consistent and follow the guidelines it can be named comments: …).
yamllint/rules/comments.py
Outdated
| expected): | ||
| yield LintProblem(comment.line_no, comment.column_no, | ||
| 'too few spaces before comment') | ||
| f'too few spaces before comment, expected {expected}') |
Owner
There was a problem hiding this comment.
- No need for a new variable, this will be good:
'too few spaces before comment, expected ' f'{conf["min-spaces-from-content"]}')
- Let's use a colon
:instead of,, to be consistent with other rules (likeindentationornew-lines).
Contributor
Author
There was a problem hiding this comment.
Sure, fixed now.
Owner
|
Hello, please reread my last review entirely! |
When telling someone that there are too few spaces before a comment it can be useful to include how many were expected.
|
Hit this issue today and came here to contribute exactly this. I hope it lands in a release soon, the current error message is terribly unhelpful. Thanks! |
Owner
|
Hello Preston, I just released it in yamllint version 1.37.1. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When telling someone that there are too few spaces before a comment it can be useful to include how many were expected.