editorconfig / specification

Specification of EditorConfig file format
https://editorconfig-specification.readthedocs.io
BSD 2-Clause "Simplified" License
89 stars 26 forks source link

Clarify that cores report all keys, whether or not supported #37

Closed cxw42 closed 1 year ago

cxw42 commented 1 year ago

Context: https://github.com/editorconfig/editorconfig-core-test/issues/50 asked why a core had to report keys like key=value. I looked at the spec, and realized that wasn't expressly called out.

Change:

xuhdev commented 1 year ago

Thank you, this sounds better +1

I'm still not entirely sure why we need to support arbitrary key-value pairs but it is like it is. :)

The reasons are:

cxw42 commented 1 year ago

I realized we had both "Terminology" and "Terms" :) so also renamed the latter.

   confusion how to parse values containing those characters. Old EditorConfig
   parsers may still allow inline comments.

-Terms
------
+Parts of an EditorConfig file
+-----------------------------

-EditorConfig defines the following terms for parts of an EditorConfig file:
+The parts of an EditorConfig file are:

 - Preamble: the lines that precedes the first section. The preamble is optional