Skip to content
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.

Sign up for GitHub

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

Remove the description of inline comments at all #31

Merged
merged 4 commits into from
Oct 30, 2022
Merged

Remove the description of inline comments at all #31

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1eaa799
Remove the description of inline comments at all
florianb May 20, 2022
6dc694b
Simplify the reference to formerly allowed inline comments
florianb Jul 7, 2022
645214f
Make a new subsection for the definitions of terms
cxw42 Oct 29, 2022
fe197cd
No inline comments; bump spec to 0.15.0
cxw42 Oct 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,6 @@ irrelevant. Each line must be one of the following:

- Blank: contains only whitespace characters.
- Comment: starts with a ``;`` or a ``#``.
- Inserting an unescaped ``#`` or ``;`` after non-whitespace characters in
a line (i.e. inline) is not parsed as a comment, nor as part of
the section name, the key pair (see below), or the value it was inserted
into. This behavior may change in the future; therefore this kind of
insertion is not recommended.
- Section Header: starts with a ``[`` and ends with a ``]``.
- May not use any non-whitespace characters outside of the surrounding
brackets.
Expand All @@ -100,6 +95,12 @@ Additionally, EditorConfig defines the following terms:
- Section Name: the string between the beginning ``[`` and the ending ``]``.
- Section: the lines starting from a Section Header until the beginning of
the next Section Header or the end of the file.


The EditorConfig file format formerly allowed the use of `;` and `#` after the
beginning of the line to mark the rest of a line as comment. This led to
confusion how to parse values containing those characters. Old EditorConfig
parsers may still allow inline comments.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The leading whitespace would probably mess up the formatting...

Technically we didn't formerly "allowed" inline comment, but we have left them undefined. So the best wording might be "formerly left the use of ; and # after the beginning of the line to mark the rest of a line as comment undefined"?


Glob Expressions
================
Expand Down