qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-21 23:44:39 -07:00
Code Releases Activity
The Go programming language
11,950 Commits 58 Branches 402 Tags 522 MiB
Go 89.6%
Assembly 5.2%
HTML 4.8%
C 0.2%
Shell 0.1%
11e113db57
Go to file
Andrew Gerrand 11e113db57 godoc: make example code more readable with new comment convention 
go/doc: move Examples to go/ast
cmd/go: use go/doc to read examples
src/pkg: update examples to use new convention

This is to make whole file examples more readable. When presented as a
complete function, preceding an Example with its output is confusing.
The new convention is to put the expected output in the final comment
of the example, preceded by the string "output:" (case insensitive).

An idiomatic example looks like this:

// This example demonstrates Foo by doing bar and quux.
func ExampleFoo() {
        // example body that does bar and quux

        // Output:
        // example output
}

R=rsc, gri
CC=golang-dev
https://golang.org/cl/5673053
2012-02-16 11:50:28 +11:00
doc fix: add fix for bufio, gzip, zlib NewWriterXxx changes. 2012-02-15 14:41:47 +11:00
include build: remove unnecessary pragmas 2012-02-06 12:45:23 -05:00
lib godoc: support for package examples, display example suffixes 2012-02-16 09:44:01 +11:00
misc go/printer: don't lose relevant parentheses when rewriting selector expressions 2012-02-15 12:25:37 -08:00
src godoc: make example code more readable with new comment convention 2012-02-16 11:50:28 +11:00
test cmd/gc: error on constant shift overflows. 2012-02-16 00:19:42 +01:00
.hgignore .hgignore: delete more dregs 2012-02-06 11:25:28 +11:00
.hgtags tag weekly.2012-02-14 2012-02-15 14:45:54 +11:00
AUTHORS A+C: David du Colombier (individual CLA) 2012-02-15 14:36:12 -05:00
CONTRIBUTORS A+C: David du Colombier (individual CLA) 2012-02-15 14:36:12 -05:00
favicon.ico
LICENSE
PATENTS
README
robots.txt godoc: serve robots.txt raw 2011-02-19 05:46:20 +11:00

README 

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.