1
0
mirror of https://github.com/golang/go synced 2024-10-04 20:31:22 -06:00
go/src/pkg/debug
Rob Pike abe384f68a all: be more idiomatic when documenting boolean return values.
Phrases like "returns whether or not the image is opaque" could be
describing what the function does (it always returns, regardless of
the opacity) or what it returns (a boolean indicating the opacity).
Even when the "or not" is missing, the phrasing is bizarre.

Go with "reports whether", which is still clunky but at least makes
it clear we're talking about the return value.

These were edited by hand. A few were cleaned up in other ways.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/11699043
2013-07-23 11:59:49 +10:00
..
dwarf debug/dwarf: support for DWARF 3 2013-03-19 13:59:37 -07:00
elf all: avoid leaking fds during tests 2013-06-21 11:13:14 +10:00
gosym all: be more idiomatic when documenting boolean return values. 2013-07-23 11:59:49 +10:00
macho debug/macho: add doc comment for FormatError 2013-03-11 12:32:47 -07:00
pe debug/pe: support PE files which contain no symbol table (if NumberOfSymbols is equal to 0 in the IMAGE_FILE_HEADER structure). 2012-10-09 11:15:53 +11:00