-
Notifications
You must be signed in to change notification settings - Fork 521
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
Improves .editorconfig compatibility #817
Conversation
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. |
# 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @dpshelio - I think you're right. I'll make that adjustment.
Places .editorconfig comments before the corresponding commands rather than after.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @pgmccann 🙌
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.