Skip to content

Commit 256287d

Browse files
committed
docs: updated README to reflect actual implementation
The explanation of comment blocks in tre README didn't match the actual implementation, it now does.
1 parent c360eba commit 256287d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,18 +103,18 @@ p.getComment("port") // Returns ["# Port number to", "# use for the server"]
103103
### Comments
104104

105105
Just like with the original `Properties` implementation, lines starting with a
106-
`#` or a `!` are considered comments. Consecutive comments lines that start
107-
with the same comment character and have no other lines in between (not even
108-
empty lines) are considered a single multi-line comment.
106+
`#` or a `!` are considered comments. Consecutive comments lines (even the ones
107+
that start with another comment character) and have no other lines in between
108+
(not even empty lines) are considered a single multi-line comment.
109109

110110
```properties
111111
# A single comment line
112112

113113
! A multi-line comment
114114
! spanning two lines
115115

116-
# This is actually a single comment line
117-
! And this is a single comment line too
116+
# This is also a multi-line comment
117+
! but using different comment chars
118118
two=Second value
119119
```
120120

0 commit comments

Comments
 (0)