1
0
mirror of https://github.com/golang/go synced 2024-11-22 21:50:03 -07:00
go/doc
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
..
articles doc: fix wiki content error 2013-07-22 12:22:14 +10:00
codewalk all: fix typos 2013-04-24 04:46:14 +08:00
devel doc: add go1.1.1 to the release notes 2013-06-13 12:43:26 +10:00
gopher doc/gopher: add high-resolution pencil sketches 2012-12-12 10:51:13 -08:00
play all: be more idiomatic when documenting boolean return values. 2013-07-23 11:59:49 +10:00
progs doc/articles: use C90 standard functions in the cgo article. 2013-06-04 01:40:53 +08:00
cmd.html doc: move /ref/cmd to /doc/cmd 2012-03-27 13:46:16 +11:00
code.html doc: Fix typo in approximation of square root 2013-05-29 13:49:51 +10:00
contrib.html doc: link to wiki Projects page instead of old Project Dashboard. 2013-02-11 09:18:31 +11:00
contribute.html doc/contribute: add "Understanding the extension" section 2013-06-05 21:09:43 -07:00
debugging_with_gdb.html doc: correct some minor HTML errors found by tidy 2013-02-28 13:32:36 -08:00
docs.html doc: link to Go 1.1 release notes 2013-05-01 10:00:05 -04:00
effective_go.html doc/effective_go: stamp out stray GOROOT reference 2013-07-17 18:48:55 +10:00
gccgo_contribute.html doc: update gccgo docs 2013-06-20 14:49:15 -07:00
gccgo_install.html doc: update gccgo docs 2013-06-20 14:49:15 -07:00
go1.1.html doc/go1.1.html: remove extra space; close some tags. 2013-06-01 10:28:04 -04:00
go1.2.txt encoding/json: coerce invalid UTF-8 to valid UTF-8 during Marshal 2013-07-12 17:37:10 -04:00
go1.html doc: misc tweaks, new links, fix broken links 2013-04-18 12:43:23 -07:00
go1compat.html doc: add note about import . to Go 1 compatibility notes 2012-03-06 17:50:11 -08:00
go_faq.html doc/go_faq: fix example. 2013-05-22 12:28:58 +10:00
go_mem.html doc: Don't imply incorrect guarantees about data races. 2012-09-11 08:47:30 +10:00
go_spec.html spec: move decl in example closer to use 2013-07-11 14:41:46 -07:00
go-logo-black.png doc: pngcrush and remove old, unused images 2012-03-08 14:18:28 +11:00
go-logo-blue.png doc: pngcrush and remove old, unused images 2012-03-08 14:18:28 +11:00
go-logo-white.png doc: pngcrush and remove old, unused images 2012-03-08 14:18:28 +11:00
godocs.js cmd/godoc: set up playground for examples that are already visible 2013-07-02 08:44:25 +10:00
help.html doc: add mention of the Go+ community 2013-01-25 08:27:34 +11:00
ie.css golang.org redesign 2010-09-16 14:01:02 +10:00
install-source.html doc/install-source.html: recent ARM and 386 updates 2013-06-09 23:15:39 +08:00
install.html doc: update linux tarball version for Go 1.1 2013-06-03 11:47:42 +10:00
jquery.js godoc: add jQuery to Go repository, rewrite godocs.js to use jQuery 2012-10-04 15:31:25 +10:00
logo-153x55.png doc: pngcrush and remove old, unused images 2012-03-08 14:18:28 +11:00
Makefile doc/progs: use test/run.go for testing on Windows 2012-09-03 03:49:03 +08:00
reference.html doc: misc tweaks, new links, fix broken links 2013-04-18 12:43:23 -07:00
root.html doc: add Game of Life to playground toys 2013-06-04 12:59:28 +10:00
share.png godoc: change link styles, add 'pop out' button 2012-03-13 11:00:11 +11:00
sieve.gif repair corrupted sieve.gif 2009-10-30 10:34:01 -07:00
style.css doc: update playground.js 2013-07-04 14:24:21 +10:00
tos.html doc: add Terms of Service 2012-03-27 09:27:43 +11:00