From 1eaa799b10b333c62566a49551986e326f961838 Mon Sep 17 00:00:00 2001 From: Florian Neumann <983507+florianb@users.noreply.github.com> Date: Fri, 20 May 2022 08:41:28 +0200 Subject: [PATCH] Remove the description of inline comments at all It looks like the current wording still leads to too much confusion: https://github.com/editorconfig/specification/pull/29#discussion_r783382976 I therefore propose to remove the explaining addition about inline comments at all, in favor of a description of the former behavior of EditorConfig parsers. --- index.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/index.rst b/index.rst index ba3c722..92bb451 100644 --- a/index.rst +++ b/index.rst @@ -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. @@ -100,6 +95,8 @@ 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 fileformat formerly allowed the use of `;` and `#` to parse the rest of a line as comment. This led to confusion how to handle values containing those characters when implementing a parser. We removed the support of inline comments entirely to make the standard easy to implement and understand. Older EditorConfig parsers may still allow inline comments. Glob Expressions ================