Skip to content

Commit

Permalink
Clarify the wording of inserting # or ; to the end of a line
Browse files Browse the repository at this point in the history 
Related editorconfig/editorconfig-core-test#46
  • Loading branch information
@xuhdev
xuhdev committed Jul 15, 2021
1 parent 3612f33 commit a07c0cd
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,11 @@ following:

- Blank: contains only whitespace characters.
- Comment: starts with a ``;`` or a ``#``.
- Inserting a ``#`` or ``;`` after non-whitespace characters in a line
(i.e., inline) shall neither be parsed as a comment nor as part of the
section name, pair (defined below) key or value in which it was inserted. This may change
in the future; thus, is not recommended.
- Inserting an unescaped ``#`` or ``;`` after non-whitespace characters in

This comment has been minimized.

Sign in to view

Copy link
@edukisto

edukisto Jul 15, 2021

Does this mean that # and ; are special characters that require escaping in section names, keys, and values to comply with the specification? In this case, there is a contradiction with the specification “Section header ... may contain any characters between the square brackets” and “Key [is] the part before the first = ... Value [is] the part after the first =...” (i. e. keys and values are sequences of any characters).
a line (i.e., inline) shall neither be parsed as a comment nor as part of
the section name, pair (defined below) key or value in which it was
inserted. This behavior may change in the future; thus, such 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 Down

0 comments on commit a07c0cd

Please sign in to comment.