mirror of
https://github.com/golang/go
synced 2024-11-23 05:00:07 -07:00
doc: remove overuse of simply
Specifically, remove simply where it is claiming that the code or the action to be carried out is simple, since the reader might disagree. R=golang-dev, bradfitz, gri CC=golang-dev https://golang.org/cl/5637048
This commit is contained in:
parent
fec7fa8b9d
commit
ae7497bda6
@ -415,7 +415,7 @@ the user is an administrator,
|
|||||||
<li>write a constructor function for <code>appError</code> that stores the
|
<li>write a constructor function for <code>appError</code> that stores the
|
||||||
stack trace for easier debugging,
|
stack trace for easier debugging,
|
||||||
<li>recover from panics inside the <code>appHandler</code>, logging the error
|
<li>recover from panics inside the <code>appHandler</code>, logging the error
|
||||||
to the console as "Critical," while simply telling the user "a serious error
|
to the console as "Critical," while telling the user "a serious error
|
||||||
has occurred." This is a nice touch to avoid exposing the user to inscrutable
|
has occurred." This is a nice touch to avoid exposing the user to inscrutable
|
||||||
error messages caused by programming errors.
|
error messages caused by programming errors.
|
||||||
See the <a href="defer_panic_recover.html">Defer, Panic, and Recover</a>
|
See the <a href="defer_panic_recover.html">Defer, Panic, and Recover</a>
|
||||||
|
@ -296,7 +296,7 @@ the user is an administrator,
|
|||||||
<li>write a constructor function for <code>appError</code> that stores the
|
<li>write a constructor function for <code>appError</code> that stores the
|
||||||
stack trace for easier debugging,
|
stack trace for easier debugging,
|
||||||
<li>recover from panics inside the <code>appHandler</code>, logging the error
|
<li>recover from panics inside the <code>appHandler</code>, logging the error
|
||||||
to the console as "Critical," while simply telling the user "a serious error
|
to the console as "Critical," while telling the user "a serious error
|
||||||
has occurred." This is a nice touch to avoid exposing the user to inscrutable
|
has occurred." This is a nice touch to avoid exposing the user to inscrutable
|
||||||
error messages caused by programming errors.
|
error messages caused by programming errors.
|
||||||
See the <a href="defer_panic_recover.html">Defer, Panic, and Recover</a>
|
See the <a href="defer_panic_recover.html">Defer, Panic, and Recover</a>
|
||||||
|
@ -916,7 +916,7 @@ The Dump* and NewChunked* functions and ClientConn, ServerConn, and
|
|||||||
ReverseProxy types have been moved from http to httputil.
|
ReverseProxy types have been moved from http to httputil.
|
||||||
|
|
||||||
The API for html/template is now a direct copy of the template API, instead of
|
The API for html/template is now a direct copy of the template API, instead of
|
||||||
exposing a single Escape function. For HTML templates, simply use the
|
exposing a single Escape function. For HTML templates, use the
|
||||||
html/template package as you would the template package.
|
html/template package as you would the template package.
|
||||||
|
|
||||||
Other changes:
|
Other changes:
|
||||||
|
@ -360,7 +360,7 @@ The name of Go functions accessed from C is subject to change. At present
|
|||||||
the name of a Go function that does not have a receiver is
|
the name of a Go function that does not have a receiver is
|
||||||
<code>prefix.package.Functionname</code>. The prefix is set by
|
<code>prefix.package.Functionname</code>. The prefix is set by
|
||||||
the <code>-fgo-prefix</code> option used when the package is compiled;
|
the <code>-fgo-prefix</code> option used when the package is compiled;
|
||||||
if the option is not used, the default is simply <code>go</code>.
|
if the option is not used, the default is <code>go</code>.
|
||||||
To call the function from C you must set the name using
|
To call the function from C you must set the name using
|
||||||
a <code>gcc</code> extension similar to the <code>gccgo</code>
|
a <code>gcc</code> extension similar to the <code>gccgo</code>
|
||||||
extension.
|
extension.
|
||||||
|
@ -9,7 +9,7 @@ import "io"
|
|||||||
// The Stream* objects are so simple that all their members are public. Users
|
// The Stream* objects are so simple that all their members are public. Users
|
||||||
// can create them themselves.
|
// can create them themselves.
|
||||||
|
|
||||||
// StreamReader wraps a Stream into an io.Reader. It simply calls XORKeyStream
|
// StreamReader wraps a Stream into an io.Reader. It calls XORKeyStream
|
||||||
// to process each slice of data which passes through.
|
// to process each slice of data which passes through.
|
||||||
type StreamReader struct {
|
type StreamReader struct {
|
||||||
S Stream
|
S Stream
|
||||||
@ -22,7 +22,7 @@ func (r StreamReader) Read(dst []byte) (n int, err error) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// StreamWriter wraps a Stream into an io.Writer. It simply calls XORKeyStream
|
// StreamWriter wraps a Stream into an io.Writer. It calls XORKeyStream
|
||||||
// to process each slice of data which passes through. If any Write call
|
// to process each slice of data which passes through. If any Write call
|
||||||
// returns short then the StreamWriter is out of sync and must be discarded.
|
// returns short then the StreamWriter is out of sync and must be discarded.
|
||||||
type StreamWriter struct {
|
type StreamWriter struct {
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
// Package driver defines interfaces to be implemented by database
|
// Package driver defines interfaces to be implemented by database
|
||||||
// drivers as used by package sql.
|
// drivers as used by package sql.
|
||||||
//
|
//
|
||||||
// Code simply using databases should use package sql.
|
// Most code should use package sql.
|
||||||
//
|
//
|
||||||
// Drivers only need to be aware of a subset of Go's types. The sql package
|
// Drivers only need to be aware of a subset of Go's types. The sql package
|
||||||
// will convert all types into one of the following:
|
// will convert all types into one of the following:
|
||||||
|
@ -135,7 +135,7 @@ func (dec *Decoder) nextUint() uint64 {
|
|||||||
// and returns the type id of the next value. It returns -1 at
|
// and returns the type id of the next value. It returns -1 at
|
||||||
// EOF. Upon return, the remainder of dec.buf is the value to be
|
// EOF. Upon return, the remainder of dec.buf is the value to be
|
||||||
// decoded. If this is an interface value, it can be ignored by
|
// decoded. If this is an interface value, it can be ignored by
|
||||||
// simply resetting that buffer.
|
// resetting that buffer.
|
||||||
func (dec *Decoder) decodeTypeSequence(isInterface bool) typeId {
|
func (dec *Decoder) decodeTypeSequence(isInterface bool) typeId {
|
||||||
for dec.err == nil {
|
for dec.err == nil {
|
||||||
if dec.buf.Len() == 0 {
|
if dec.buf.Len() == 0 {
|
||||||
|
@ -16,7 +16,7 @@
|
|||||||
//
|
//
|
||||||
// The package is sometimes only imported for the side effect of
|
// The package is sometimes only imported for the side effect of
|
||||||
// registering its HTTP handler and the above variables. To use it
|
// registering its HTTP handler and the above variables. To use it
|
||||||
// this way, simply link this package into your program:
|
// this way, link this package into your program:
|
||||||
// import _ "expvar"
|
// import _ "expvar"
|
||||||
//
|
//
|
||||||
package expvar
|
package expvar
|
||||||
|
@ -52,7 +52,7 @@ type cell struct {
|
|||||||
// this flag.
|
// this flag.
|
||||||
//
|
//
|
||||||
// If a Writer is configured to filter HTML, HTML tags and entities
|
// If a Writer is configured to filter HTML, HTML tags and entities
|
||||||
// are simply passed through. The widths of tags and entities are
|
// are passed through. The widths of tags and entities are
|
||||||
// assumed to be zero (tags) and one (entities) for formatting purposes.
|
// assumed to be zero (tags) and one (entities) for formatting purposes.
|
||||||
//
|
//
|
||||||
// A segment of text may be escaped by bracketing it with Escape
|
// A segment of text may be escaped by bracketing it with Escape
|
||||||
@ -448,7 +448,7 @@ func handlePanic(err *error) {
|
|||||||
|
|
||||||
// Flush should be called after the last call to Write to ensure
|
// Flush should be called after the last call to Write to ensure
|
||||||
// that any data buffered in the Writer is written to output. Any
|
// that any data buffered in the Writer is written to output. Any
|
||||||
// incomplete escape sequence at the end is simply considered
|
// incomplete escape sequence at the end is considered
|
||||||
// complete for formatting purposes.
|
// complete for formatting purposes.
|
||||||
//
|
//
|
||||||
func (b *Writer) Flush() (err error) {
|
func (b *Writer) Flush() (err error) {
|
||||||
|
Loading…
Reference in New Issue
Block a user