mirror of
https://github.com/golang/go
synced 2024-10-08 00:41:20 -06:00
11e113db57
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
29 lines
656 B
Go
29 lines
656 B
Go
// Copyright 2011 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package bytes_test
|
|
|
|
import (
|
|
. "bytes"
|
|
"encoding/base64"
|
|
"io"
|
|
"os"
|
|
)
|
|
|
|
func ExampleBuffer() {
|
|
var b Buffer // A Buffer needs no initialization.
|
|
b.Write([]byte("Hello "))
|
|
b.Write([]byte("world!"))
|
|
b.WriteTo(os.Stdout)
|
|
// Output: Hello world!
|
|
}
|
|
|
|
func ExampleBuffer_reader() {
|
|
// A Buffer can turn a string or a []byte into an io.Reader.
|
|
buf := NewBufferString("R29waGVycyBydWxlIQ==")
|
|
dec := base64.NewDecoder(base64.StdEncoding, buf)
|
|
io.Copy(os.Stdout, dec)
|
|
// Output: Gophers rule!
|
|
}
|