Clarify whitespace handling #46
Open
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
Change single-backticks to double-backticks as required by rst.
Previously, the rule for blank lines technically did not cover empty lines. Clarify that blank lines are lines that are empty after any leading whitespace is removed. Also clarify that the trailing line separator (if any) is ignored.
Make the spec conform to existing test `spaces_after_section_name`. Fixes editorconfig/editorconfig#500
xuhdev
reviewed
Feb 13, 2024
|
|
||
| - Blank: contains only whitespace characters. | ||
| - Blank: contains nothing. |
There was a problem hiding this comment.
Maybe
Suggested change
| - Blank: contains nothing. | |
| - Blank: contains nothing or only whitespace characters. |
?
There was a problem hiding this comment.
Indeed, I scratched my head a bit about that as well. The line just before the bullets says "once leading whitespace is removed", so there would be nothing left. I thought that was cleaner than adding "may contain leading whitespace" to each bullet.
How about moving blanks out of the bullets? Something like:
+When reading an EditorConfig file, the following are ignored:
+ - blank lines (empty, or nothing but whitespace)
+ - all beginning whitespace on each line.
+Each non-blank line must be one of the following, once leading whitespace is removed
+(and ignoring any trailing line separator):
- - Blank: contains only whitespace characters
- Comment: ...
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.
Fixes editorconfig/editorconfig#500