Clarify that comments never affect the tables produced by parsers (#950)

* Clarify comments never affect resulting tables * Simplify parser restriction on comments Co-authored-by: Pradyun Gedam <[email protected]> --------- Co-authored-by: Pradyun Gedam <[email protected]>
toml-lang · Aug 6, 2024 · dc5af25 · dc5af25
1 parent 2431aa3
commit dc5af25
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## unreleased
 
+- Clarify that comments never affect the tables produced by parsers.
 - Clarify Unicode and UTF-8 references.
 - Relax comment parsing; most control characters are again permitted.
 - Allow newline after key/values in inline tables.

diff --git a/toml.md b/toml.md
@@ -61,6 +61,10 @@ Comments may contain any Unicode code points except the following control codes
 that could cause problems during editing or processing: U+0000, and U+000A to
 U+000D.
 
+Comments should be used to communicate between the human readers of a file.
+Parsers must not modify keys or values, based on the presence (or contents) of a
+comment.
+
 ## Key/Value Pair
 
 The primary building block of a TOML document is the key/value pair.