Skip to content

Commit dd2b97a

Browse files
committed
Update README.md
1 parent cd7686c commit dd2b97a

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -258,28 +258,14 @@ This implementation stores the comments for a collection in a string called a "c
258258

259259
The readme in package note gets into all the specifics.
260260

261-
262261
Changes
263262
-----
264263

265-
0.3 -> 0.4:
266-
- adopt the golang (package stringconv) rules for escaping strings.
267-
- simplify the attribution of comments in the space between a key (or dash) and its value.
268-
- change the decoder api to support custom sequences, mirroring custom maps; package 'maps' is now more generically package 'collect'.
269-
- encoding/decoding heredocs for multiline strings
270-
- encoding/decoding of arrays; ( encoding will write empty collections as arrays; future: a heuristic to determine what should be encoded as an array, vs. sequence. )
271-
- the original idea for arrays was to use a bare comma full-stop format. switched to square brackets because they are easier to decode, they can support nesting, and are going to be more familiar to most users. ( plus, full stop (.) is tiny and easy to miss when looking at documents. )
272-
273-
0.4 -> 0.5:
274-
- simplify comment handling
275-
276-
0.5 -> 0.6:
277-
- bug fixes, and re-encoding of comments
264+
0.8.0 -> 0.8.1:
265+
- catch tabs in whitespace
266+
- bug fix: report better errors when unable to decode a mistyped boolean literal (ex. `truex` )
278267

279-
0.6 -> 0.7:
280-
- replace comment raw string buffer usage with an opaque object ( to make any future changes more friendly )
281-
282-
0.7 -> 0.8:
268+
0.7.0 -> 0.8.0:
283269
- Changes the encoder's interface to support customizing the comment style of mappings and sequences independently.
284270
- bug fix: when specifying map values: allow sequences to start at the same indentation as the key and allow a new map term to start after the sequence ends. ( previously, it generated an error, and an additional indentation was required. ) For example:
285271
```yaml
@@ -288,8 +274,25 @@ Changes
288274
Second: # Second is an additional entry in the same map as First
289275
- "okay"
290276
```
291-
- bug fix: for all other values, an indentation greater than the key is required. For example:
277+
- bug fix: for all other values, an indentation greater than the key is required. For example:
292278
```yaml
293279
First:
294280
"this is an error."
295-
```
281+
```
282+
283+
0.6 -> 0.7.0:
284+
- replace comment raw string buffer usage with an opaque object ( to make any future changes more friendly )
285+
286+
0.5 -> 0.6:
287+
- bug fixes, and re-encoding of comments
288+
289+
0.4 -> 0.5:
290+
- simplify comment handling
291+
292+
0.3 -> 0.4:
293+
- adopt the golang (package stringconv) rules for escaping strings.
294+
- simplify the attribution of comments in the space between a key (or dash) and its value.
295+
- change the decoder api to support custom sequences, mirroring custom maps; package 'maps' is now more generically package 'collect'.
296+
- encoding/decoding heredocs for multiline strings
297+
- encoding/decoding of arrays; ( encoding will write empty collections as arrays; future: a heuristic to determine what should be encoded as an array, vs. sequence. )
298+
- the original idea for arrays was to use a bare comma full-stop format. switched to square brackets because they are easier to decode, they can support nesting, and are going to be more familiar to most users. ( plus, full stop (.) is tiny and easy to miss when looking at documents. )

0 commit comments

Comments
 (0)