Skip to content

Commit

Permalink
Improves .editorconfig compatibility (#817)
Browse files Browse the repository at this point in the history
* Improves .editorconfig compatibility

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.

* Leading .editorconfig comments

Places .editorconfig comments before the corresponding commands rather than after.
  • Loading branch information
pgmccann authored Oct 2, 2024
1 parent dfd59d9 commit a5cd828
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,12 @@ trim_trailing_whitespace = true
[*.md]
indent_size = 2
indent_style = space
max_line_length = 100 # 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/>)

# Please keep this in sync with bin/lesson_check.py!
max_line_length = 100

# keep trailing spaces in markdown - 2+ spaces are translated to a hard break (<br/>)
trim_trailing_whitespace = false

[*.r]
max_line_length = 80
Expand Down

0 comments on commit a5cd828

Please sign in to comment.