]> Cypherpunks repositories - gostls13.git/commit
all: fix various doc comment formatting nits
authorRuss Cox <rsc@golang.org>
Sun, 30 Jan 2022 00:07:27 +0000 (19:07 -0500)
committerRuss Cox <rsc@golang.org>
Fri, 1 Apr 2022 18:18:01 +0000 (18:18 +0000)
commit7d87ccc860dc31c0cd60faf00720e2f30fd37efb
tree3dc01e7fa04a4683de0583774fab0e881bae7193
parentdf89f2ba53aab53356be197c581d142cefc2c6bc
all: fix various doc comment formatting nits

A run of lines that are indented with any number of spaces or tabs
format as a <pre> block. This commit fixes various doc comments
that format badly according to that (standard) rule.

For example, consider:

// - List item.
//   Second line.
// - Another item.

Because the - lines are unindented, this is actually two paragraphs
separated by a one-line <pre> block. This CL rewrites it to:

//  - List item.
//    Second line.
//  - Another item.

Today, that will format as a single <pre> block.
In a future release, we hope to format it as a bulleted list.

Various other minor fixes as well, all in preparation for reformatting.

For #51082.

Change-Id: I95cf06040d4186830e571cd50148be3bf8daf189
Reviewed-on: https://go-review.googlesource.com/c/go/+/384257
Trust: Russ Cox <rsc@golang.org>
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
63 files changed:
src/cmd/compile/internal/abi/abiutils.go
src/cmd/compile/internal/ir/expr.go
src/cmd/compile/internal/noder/unified.go
src/cmd/compile/internal/reflectdata/reflect.go
src/cmd/compile/internal/ssa/block.go
src/cmd/compile/internal/ssa/branchelim.go
src/cmd/compile/internal/ssa/compile.go
src/cmd/compile/internal/ssa/func.go
src/cmd/compile/internal/ssa/fuse_branchredirect.go
src/cmd/compile/internal/ssa/location.go
src/cmd/compile/internal/ssa/loopbce.go
src/cmd/compile/internal/ssa/phiopt.go
src/cmd/compile/internal/ssa/prove.go
src/cmd/compile/internal/ssa/sparsetree.go
src/cmd/compile/internal/ssa/writebarrier.go
src/cmd/compile/internal/syntax/parser.go
src/cmd/compile/internal/typecheck/subr.go
src/cmd/compile/internal/types/size.go
src/cmd/compile/internal/types/type.go
src/cmd/compile/internal/types2/infer.go
src/cmd/compile/internal/types2/object.go
src/cmd/compile/internal/walk/builtin.go
src/cmd/compile/internal/walk/range.go
src/cmd/dist/buildgo.go
src/cmd/go/script_test.go
src/cmd/internal/goobj/objfile.go
src/cmd/internal/obj/arm64/doc.go
src/cmd/internal/obj/inl.go
src/cmd/internal/obj/objfile.go
src/cmd/internal/obj/ppc64/doc.go
src/cmd/internal/obj/riscv/cpu.go
src/cmd/internal/obj/riscv/obj.go
src/cmd/link/internal/benchmark/bench.go
src/cmd/link/internal/ld/elf.go
src/cmd/link/internal/ld/outbuf.go
src/cmd/link/internal/loader/loader.go
src/cmd/link/internal/s390x/asm.go
src/compress/flate/huffman_code.go
src/crypto/cipher/gcm.go
src/crypto/elliptic/p256.go
src/crypto/x509/x509.go
src/database/sql/fakedb_test.go
src/debug/gosym/pclntab_test.go
src/fmt/doc.go
src/go/doc/comment.go
src/go/types/object.go
src/math/big/nat.go
src/net/cgo_unix.go
src/net/http/client.go
src/net/http/cookie.go
src/net/http/server.go
src/net/smtp/smtp_test.go
src/os/file_windows.go
src/runtime/chan.go
src/runtime/mheap.go
src/runtime/netpoll.go
src/runtime/proc.go
src/runtime/runtime2.go
src/runtime/string.go
src/runtime/symtab_test.go
src/runtime/type.go
src/syscall/exec_windows.go
src/time/zoneinfo.go