]> Cypherpunks repositories - gostls13.git/commitdiff
encoding/json: document Indent's preservation of trailing spaces
authorRuss Cox <rsc@golang.org>
Tue, 8 Dec 2015 19:09:59 +0000 (14:09 -0500)
committerRuss Cox <rsc@golang.org>
Tue, 8 Dec 2015 19:26:26 +0000 (19:26 +0000)
Fixes #13520.

Change-Id: Ia70cc44be3912167b369d7f74d3436331975c300
Reviewed-on: https://go-review.googlesource.com/17561
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
src/encoding/json/indent.go

index 153109fae6e6c83cf5a04e79c74b1914826799c3..7cd9f4db184a7df373603b18f8f98be1c941f89e 100644 (file)
@@ -70,8 +70,12 @@ func newline(dst *bytes.Buffer, prefix, indent string, depth int) {
 // indented line beginning with prefix followed by one or more
 // copies of indent according to the indentation nesting.
 // The data appended to dst does not begin with the prefix nor
-// any indentation, and has no trailing newline, to make it
-// easier to embed inside other formatted JSON data.
+// any indentation, to make it easier to embed inside other formatted JSON data.
+// Although leading space characters (space, tab, carriage return, newline)
+// at the beginning of src are dropped, trailing space characters
+// at the end of src are preserved and copied to dst.
+// For example, if src has no trailing spaces, neither will dst;
+// if src ends in a trailing newline, so will dst.
 func Indent(dst *bytes.Buffer, src []byte, prefix, indent string) error {
        origLen := dst.Len()
        var scan scanner