encoding/json/jsontext: improve Encoder/Decoder documentation

Cleanup the documentation on:
* Encoder.StackDepth and Decoder.StackDepth by more thoroughly
explaining what the index value means with examples.
* Encoder.StackIndex and Decoder.StackIndex by explicitly calling
out that it returns the length of the JSON array or object
as progressively processed so far.
* Encoder.AvailableBuffer by cautioning the user on
the correct use of it with a subsequent WriteValue call.
* Encoder.WriteToken by removing language about the error offset
"[being] relative to Encoder.OutputOffset" and just explicitly say
how it is computed.

Updates #79733

Change-Id: Ie787b72c9ebaff019c7f8120d1a64cd517707df3
Reviewed-on: https://go-review.googlesource.com/c/go/+/789080
Reviewed-by: Cherry Mui <cherryyz@google.com>
Reviewed-by: Michael Pratt <mpratt@google.com>
LUCI-TryBot-Result: golang-scoped@luci-project-accounts.iam.gserviceaccount.com <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
2 files changed
tree: 96dd99c954a6557f0231abbd5de8719495894df3
  1. .github/
  2. api/
  3. doc/
  4. lib/
  5. misc/
  6. src/
  7. test/
  8. .gitattributes
  9. .gitignore
  10. codereview.cfg
  11. CONTRIBUTING.md
  12. go.env
  13. LICENSE
  14. PATENTS
  15. README.md
  16. SECURITY.md
README.md

The Go Programming Language

Go is an open source programming language that makes it easy to build simple, reliable, and efficient software.

Gopher image Gopher image by Renee French, licensed under Creative Commons 4.0 Attribution license.

Our canonical Git repository is located at https://go.googlesource.com/go. There is a mirror of the repository at https://github.com/golang/go.

Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.

Download and Install

Binary Distributions

Official binary distributions are available at https://go.dev/dl/.

After downloading a binary release, visit https://go.dev/doc/install for installation instructions.

Install From Source

If a binary distribution is not available for your combination of operating system and architecture, visit https://go.dev/doc/install/source for source installation instructions.

Contributing

Go is the work of thousands of contributors. We appreciate your help!

To contribute, please read the contribution guidelines at https://go.dev/doc/contribute.

Note that the Go project uses the issue tracker for bug reports and proposals only. See https://go.dev/wiki/Questions for a list of places to ask questions about the Go language.