Improves .editorconfig compatibility #817
Merged
Conversation
This file contains 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
My text editor (NeoVim) reports the following error when editing a workshop template: ``` editorconfig: invalid value for option trim_trailing_whitespace: false # keep trailing spaces in markdown - 2+ spaces are translated to a hard break (<br/>). trim_trailing_whitespace must be either "true" or "false" editorconfig: invalid value for option max_line_length: 100 # please keep this in sync with bin/lesson_check.py!. max_line_length must be a number or "off" ``` As per https://editorconfig.org: > Comments should go on their own lines. This change brings .editorconfig in line with the file format as documented.
✅ Deploy Preview for workshop-template-previews ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
dpshelio
reviewed
Sep 6, 2024
| # Please keep this in sync with bin/lesson_check.py! | ||
|
|
||
| trim_trailing_whitespace = false | ||
| # keep trailing spaces in markdown - 2+ spaces are translated to a hard break (<br/>) |
There was a problem hiding this comment.
I think having the comments before the options are set (i.e., above rather than below) are clearer at signalling the reader what's coming and maybe safer that people would read it if changing it. But that may be a habit I've got.
There was a problem hiding this comment.
Thanks @dpshelio - I think you're right. I'll make that adjustment.
Places .editorconfig comments before the corresponding commands rather than after.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
My text editor (NeoVim) reports the following error when editing a workshop template:
As per https://editorconfig.org:
This change brings .editorconfig in line with the file format as documented.