1
0
mirror of https://github.com/golang/go synced 2024-11-17 16:04:47 -07:00
The Go programming language
Go to file
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
api api: update next.txt 2013-06-14 10:00:07 -07:00
doc all: be more idiomatic when documenting boolean return values. 2013-07-23 11:59:49 +10:00
include include/plan9: define size_t to fix build breakage 2013-06-28 12:16:33 -07:00
lib cmd/godoc: set up playground for examples that are already visible 2013-07-02 08:44:25 +10:00
misc misc/cgo/test: add test for cgo callbacks with different amount of stack space available 2013-07-22 21:53:20 +04:00
src all: be more idiomatic when documenting boolean return values. 2013-07-23 11:59:49 +10:00
test test: fix error output in the test 2013-07-19 17:48:19 +04:00
.hgignore hgignore: cleanup obsolete entries. 2013-06-02 11:36:09 +02:00
.hgtags tag go1.1.1 2013-06-13 12:52:02 +10:00
AUTHORS A+C: Alexandre Normand (individual CLA) 2013-07-15 10:52:21 +10:00
CONTRIBUTORS CONTRIBUTORS: add Drew Hintz (Google CLA) 2013-07-16 17:37:22 -04:00
favicon.ico godoc: update favicon 2012-10-11 17:02:36 +11:00
LICENSE doc: update licensing text one more time 2012-03-27 15:09:13 +11:00
PATENTS
README
robots.txt

This is the source code repository for the Go programming language.  

For documentation about how to install and use Go,
visit http://golang.org/ or load doc/install.html in your web browser.

After installing Go, you can view a nicely formatted
doc/install.html by running godoc --http=:6060
and then visiting http://localhost:6060/doc/install.html.

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

--

Binary Distribution Notes

If you have just untarred a binary Go distribution, you need to set
the environment variable $GOROOT to the full path of the go
directory (the one containing this README).  You can omit the
variable if you unpack it into /usr/local/go, or if you rebuild
from sources by running all.bash (see doc/install.html).
You should also add the Go binary directory $GOROOT/bin
to your shell's path.

For example, if you extracted the tar file into $HOME/go, you might
put the following in your .profile:

    export GOROOT=$HOME/go
    export PATH=$PATH:$GOROOT/bin

See doc/install.html for more details.