Skip to content

Commit d166a0b

Browse files
neildgopherbot
authored andcommitted
encoding/json/jsontext, encoding/json/v2: document experimental nature
Change-Id: I7b2c391749e0113e006f37b2ac1ebfe3ee0a4e0e Reviewed-on: https://go-review.googlesource.com/c/go/+/680715 TryBot-Bypass: Damien Neil <dneil@google.com> Reviewed-by: Cherry Mui <cherryyz@google.com> Reviewed-by: Joseph Tsai <joetsai@digital-static.net> Auto-Submit: Damien Neil <dneil@google.com>
1 parent d4c6eff commit d166a0b

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

src/encoding/json/jsontext/doc.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010
// primitive data types such as booleans, strings, and numbers,
1111
// in addition to structured data types such as objects and arrays.
1212
//
13+
// This package (encoding/json/jsontxt) is experimental,
14+
// and not subject to the Go 1 compatibility promise.
15+
// It only exists when building with the GOEXPERIMENT=jsonv2 environment variable set.
16+
// Most users should use [encoding/json].
17+
//
1318
// The [Encoder] and [Decoder] types are used to encode or decode
1419
// a stream of JSON tokens or values.
1520
//

src/encoding/json/v2/doc.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99
// primitive data types such as booleans, strings, and numbers,
1010
// in addition to structured data types such as objects and arrays.
1111
//
12+
// This package (encoding/json/v2) is experimental,
13+
// and not subject to the Go 1 compatibility promise.
14+
// It only exists when building with the GOEXPERIMENT=jsonv2 environment variable set.
15+
// Most users should use [encoding/json].
16+
//
1217
// [Marshal] and [Unmarshal] encode and decode Go values
1318
// to/from JSON text contained within a []byte.
1419
// [MarshalWrite] and [UnmarshalRead] operate on JSON text

0 commit comments

Comments
 (0)