code review 5637048: doc: remove overuse of simply

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.

[rsc, 2012-02-06 17:33:51]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://go.googlecode.com/hg/

[bradfitz, 2012-02-06 17:37:39]

LGTM

On Mon, Feb 6, 2012 at 9:33 AM, <rsc@golang.org> wrote:

> Reviewers: golang-dev_googlegroups.com,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://go.googlecode.com/hg/
>
>
> Description:
> 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.
>
> Please review this at
http://codereview.appspot.com/**5637048/<http://codereview.appspot.com/5637048/>
>
> Affected files:
>  M doc/articles/error_handling.**html
>  M doc/articles/error_handling.**tmpl
>  M doc/devel/weekly.html
>  M doc/gccgo_install.html
>  M src/pkg/crypto/cipher/io.go
>  M src/pkg/database/sql/driver/**driver.go
>  M src/pkg/encoding/gob/decoder.**go
>  M src/pkg/expvar/expvar.go
>  M src/pkg/text/tabwriter/**tabwriter.go
>
>
> Index: doc/articles/error_handling.**html
> ==============================**==============================**=======
> --- a/doc/articles/error_handling.**html
> +++ b/doc/articles/error_handling.**html
> @@ -415,7 +415,7 @@
>  <li>write a constructor function for <code>appError</code> that stores the
>  stack trace for easier debugging,
>  <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
>  error messages caused by programming errors.
>  See the <a href="defer_panic_recover.**html">Defer, Panic, and
> Recover</a>
> Index: doc/articles/error_handling.**tmpl
> ==============================**==============================**=======
> --- a/doc/articles/error_handling.**tmpl
> +++ b/doc/articles/error_handling.**tmpl
> @@ -296,7 +296,7 @@
>  <li>write a constructor function for <code>appError</code> that stores the
>  stack trace for easier debugging,
>  <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
>  error messages caused by programming errors.
>  See the <a href="defer_panic_recover.**html">Defer, Panic, and
> Recover</a>
> Index: doc/devel/weekly.html
> ==============================**==============================**=======
> --- a/doc/devel/weekly.html
> +++ b/doc/devel/weekly.html
> @@ -916,7 +916,7 @@
>  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
> -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.
>
>  Other changes:
> Index: doc/gccgo_install.html
> ==============================**==============================**=======
> --- a/doc/gccgo_install.html
> +++ b/doc/gccgo_install.html
> @@ -360,7 +360,7 @@
>  the name of a Go function that does not have a receiver is
>  <code>prefix.package.**Functionname</code>. The prefix is set by
>  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
>  a <code>gcc</code> extension similar to the <code>gccgo</code>
>  extension.
> Index: src/pkg/crypto/cipher/io.go
> ==============================**==============================**=======
> --- a/src/pkg/crypto/cipher/io.go
> +++ b/src/pkg/crypto/cipher/io.go
> @@ -9,7 +9,7 @@
>  // The Stream* objects are so simple that all their members are public.
> Users
>  // 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.
>  type StreamReader struct {
>        S Stream
> @@ -22,7 +22,7 @@
>        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
>  // returns short then the StreamWriter is out of sync and must be
> discarded.
>  type StreamWriter struct {
> Index: src/pkg/database/sql/driver/**driver.go
> ==============================**==============================**=======
> --- a/src/pkg/database/sql/driver/**driver.go
> +++ b/src/pkg/database/sql/driver/**driver.go
> @@ -5,7 +5,7 @@
>  // Package driver defines interfaces to be implemented by database
>  // drivers as used by package sql.
>  //
> -// Code simply using databases should use package sql.
> +// Code using databases should use package sql.
>  //
>  // 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:
> Index: src/pkg/encoding/gob/decoder.**go
> ==============================**==============================**=======
> --- a/src/pkg/encoding/gob/**decoder.go
> +++ b/src/pkg/encoding/gob/**decoder.go
> @@ -135,7 +135,7 @@
>  // 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
>  // 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 {
>        for dec.err == nil {
>                if dec.buf.Len() == 0 {
> Index: src/pkg/expvar/expvar.go
> ==============================**==============================**=======
> --- a/src/pkg/expvar/expvar.go
> +++ b/src/pkg/expvar/expvar.go
> @@ -16,7 +16,7 @@
>  //
>  // The package is sometimes only imported for the side effect of
>  // 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"
>  //
>  package expvar
> Index: src/pkg/text/tabwriter/**tabwriter.go
> ==============================**==============================**=======
> --- a/src/pkg/text/tabwriter/**tabwriter.go
> +++ b/src/pkg/text/tabwriter/**tabwriter.go
> @@ -52,7 +52,7 @@
>  // this flag.
>  //
>  // 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.
>  //
>  // A segment of text may be escaped by bracketing it with Escape
> @@ -448,7 +448,7 @@
>
>  // Flush should be called after the last call to Write to ensure
>  // 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.
>  //
>  func (b *Writer) Flush() (err error) {
>
>
>

[gri, 2012-02-06 17:38:35]

LGTM

http://codereview.appspot.com/5637048/diff/1002/src/pkg/database/sql/driver/d...
File src/pkg/database/sql/driver/driver.go (right):

http://codereview.appspot.com/5637048/diff/1002/src/pkg/database/sql/driver/d...
src/pkg/database/sql/driver/driver.go:8: // Code using databases should use
package sql.
s/Code/Code only/ ?

[rsc, 2012-02-06 18:23:22]

On Mon, Feb 6, 2012 at 12:38,  <gri@golang.org> wrote:
> s/Code/Code only/ ?

Changed to

Most code should use package sql.

[rsc, 2012-02-06 18:34:38]

*** Submitted as http://code.google.com/p/go/source/detail?r=4609ed199ec5 ***

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
http://codereview.appspot.com/5637048

[r, 2012-02-06 20:13:04]

That's simply great.

Actually, I believe we frequently overuse other adverbs generally.

-rob

[adg1, 2012-02-06 21:56:26]

On Feb 7, 2012 7:13 AM, <r@golang.org> wrote:
>
> That's simply great.
>
> Actually, I believe we frequently overuse other adverbs generally.

Totally.

> -rob
>
>
> http://codereview.appspot.com/5637048/