mirror of
https://github.com/golang/go
synced 2024-11-20 10:34:42 -07:00
encoding/json: update documentation for MarshalIndent
Make arguments semantics clear without the need to look for json.Indent documentation. Change-Id: If9adfe9f477a30d426ae83790b0f2578c0a809b7 Reviewed-on: https://go-review.googlesource.com/61670 Run-TryBot: Ian Lance Taylor <iant@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Ian Lance Taylor <iant@golang.org>
This commit is contained in:
parent
80b2ae5878
commit
b86fae041b
@ -166,6 +166,8 @@ func Marshal(v interface{}) ([]byte, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// MarshalIndent is like Marshal but applies Indent to format the output.
|
// MarshalIndent is like Marshal but applies Indent to format the output.
|
||||||
|
// Each JSON element in the output will begin on a new line beginning with prefix
|
||||||
|
// followed by one or more copies of indent according to the indentation nesting.
|
||||||
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error) {
|
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error) {
|
||||||
b, err := Marshal(v)
|
b, err := Marshal(v)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
@ -273,3 +273,22 @@ func ExampleIndent() {
|
|||||||
// = }
|
// = }
|
||||||
// =]
|
// =]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func ExampleMarshalIndent() {
|
||||||
|
data := map[string]int{
|
||||||
|
"a": 1,
|
||||||
|
"b": 2,
|
||||||
|
}
|
||||||
|
|
||||||
|
json, err := json.MarshalIndent(data, "<prefix>", "<indent>")
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println(string(json))
|
||||||
|
// Output:
|
||||||
|
// {
|
||||||
|
// <prefix><indent>"a": 1,
|
||||||
|
// <prefix><indent>"b": 2
|
||||||
|
// <prefix>}
|
||||||
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user