aboutsummaryrefslogtreecommitdiff
path: root/src/encoding
diff options
context:
space:
mode:
authorJoe Tsai <joetsai@digital-static.net>2025-06-21 10:51:08 -0700
committerJoseph Tsai <joetsai@digital-static.net>2025-06-23 15:35:18 -0700
commit4506796a6ebee9799dd6272c0fb12c7b993631e2 (patch)
treecccbc0d7ba6c850aa45b8d1a29be1f97181d8e4a /src/encoding
parent456a90aa1618a6c3aa49ecba46969128e2bfa26f (diff)
downloadgo-4506796a6ebee9799dd6272c0fb12c7b993631e2.tar.xz
encoding/json/jsontext: consistently use JSON terminology
RFC 8259, section 2 uses the term "begin-array" amd "begin-object" rather than "start array" or "start object". Be consistent in our documentation. Change-Id: I172eb354c5e64b84c74bd662b1e581424e719a32 Reviewed-on: https://go-review.googlesource.com/c/go/+/683155 Auto-Submit: Joseph Tsai <joetsai@digital-static.net> Reviewed-by: Damien Neil <dneil@google.com> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
Diffstat (limited to 'src/encoding')
-rw-r--r--src/encoding/json/jsontext/doc.go4
-rw-r--r--src/encoding/json/jsontext/encode.go4
-rw-r--r--src/encoding/json/jsontext/state.go4
-rw-r--r--src/encoding/json/jsontext/token.go8
4 files changed, 10 insertions, 10 deletions
diff --git a/src/encoding/json/jsontext/doc.go b/src/encoding/json/jsontext/doc.go
index 20ef5271d7..8e4bced015 100644
--- a/src/encoding/json/jsontext/doc.go
+++ b/src/encoding/json/jsontext/doc.go
@@ -25,8 +25,8 @@
// - a JSON literal (i.e., null, true, or false)
// - a JSON string (e.g., "hello, world!")
// - a JSON number (e.g., 123.456)
-// - a start or end delimiter for a JSON object (i.e., '{' or '}')
-// - a start or end delimiter for a JSON array (i.e., '[' or ']')
+// - a begin or end delimiter for a JSON object (i.e., '{' or '}')
+// - a begin or end delimiter for a JSON array (i.e., '[' or ']')
//
// A JSON token is represented by the [Token] type in Go. Technically,
// there are two additional structural characters (i.e., ':' and ','),
diff --git a/src/encoding/json/jsontext/encode.go b/src/encoding/json/jsontext/encode.go
index a1e6307adc..4853a11059 100644
--- a/src/encoding/json/jsontext/encode.go
+++ b/src/encoding/json/jsontext/encode.go
@@ -713,7 +713,7 @@ func (e *encoderState) reformatValue(dst []byte, src Value, depth int) ([]byte,
// appends it to the end of src, reformatting whitespace and strings as needed.
// It returns the extended dst buffer and the number of consumed input bytes.
func (e *encoderState) reformatObject(dst []byte, src Value, depth int) ([]byte, int, error) {
- // Append object start.
+ // Append object begin.
if len(src) == 0 || src[0] != '{' {
panic("BUG: reformatObject must be called with a buffer that starts with '{'")
} else if depth == maxNestingDepth+1 {
@@ -824,7 +824,7 @@ func (e *encoderState) reformatObject(dst []byte, src Value, depth int) ([]byte,
// appends it to the end of dst, reformatting whitespace and strings as needed.
// It returns the extended dst buffer and the number of consumed input bytes.
func (e *encoderState) reformatArray(dst []byte, src Value, depth int) ([]byte, int, error) {
- // Append array start.
+ // Append array begin.
if len(src) == 0 || src[0] != '[' {
panic("BUG: reformatArray must be called with a buffer that starts with '['")
} else if depth == maxNestingDepth+1 {
diff --git a/src/encoding/json/jsontext/state.go b/src/encoding/json/jsontext/state.go
index 1e8b4f22db..d214fd5190 100644
--- a/src/encoding/json/jsontext/state.go
+++ b/src/encoding/json/jsontext/state.go
@@ -297,7 +297,7 @@ func (m *stateMachine) appendNumber() error {
return m.appendLiteral()
}
-// pushObject appends a JSON start object token as next in the sequence.
+// pushObject appends a JSON begin object token as next in the sequence.
// If an error is returned, the state is not mutated.
func (m *stateMachine) pushObject() error {
switch {
@@ -332,7 +332,7 @@ func (m *stateMachine) popObject() error {
}
}
-// pushArray appends a JSON start array token as next in the sequence.
+// pushArray appends a JSON begin array token as next in the sequence.
// If an error is returned, the state is not mutated.
func (m *stateMachine) pushArray() error {
switch {
diff --git a/src/encoding/json/jsontext/token.go b/src/encoding/json/jsontext/token.go
index 22717b154a..e78c3f84d8 100644
--- a/src/encoding/json/jsontext/token.go
+++ b/src/encoding/json/jsontext/token.go
@@ -33,8 +33,8 @@ var errInvalidToken = errors.New("invalid jsontext.Token")
// - a JSON literal (i.e., null, true, or false)
// - a JSON string (e.g., "hello, world!")
// - a JSON number (e.g., 123.456)
-// - a start or end delimiter for a JSON object (i.e., { or } )
-// - a start or end delimiter for a JSON array (i.e., [ or ] )
+// - a begin or end delimiter for a JSON object (i.e., { or } )
+// - a begin or end delimiter for a JSON array (i.e., [ or ] )
//
// A Token cannot represent entire array or object values, while a [Value] can.
// There is no Token to represent commas and colons since
@@ -481,9 +481,9 @@ func (t Token) Kind() Kind {
// - 't': true
// - '"': string
// - '0': number
-// - '{': object start
+// - '{': object begin
// - '}': object end
-// - '[': array start
+// - '[': array begin
// - ']': array end
//
// An invalid kind is usually represented using 0,