From 0532f4d382ad4f9813dcebcf4cfb1a086c8588bf Mon Sep 17 00:00:00 2001 From: Shenghou Ma Date: Wed, 21 Mar 2012 09:33:55 -0700 Subject: [PATCH] doc/effective_go: minor corrections R=golang-dev, gri CC=golang-dev https://golang.org/cl/5848063 --- doc/effective_go.html | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/effective_go.html b/doc/effective_go.html index f93a8645d9c..12c0bfb2f63 100644 --- a/doc/effective_go.html +++ b/doc/effective_go.html @@ -771,7 +771,7 @@ error code secreted away in a volatile location. In Go, Write can return a count and an error: “Yes, you wrote some bytes but not all of them because you filled the device”. -The signature of *File.Write in package os is: +The signature of File.Write in package os is:

@@ -1327,9 +1327,9 @@ values of different types.
 The key can be of any type for which the equality operator is defined,
 such as integers,
 floating point and complex numbers,
-strings, pointers, and interfaces (as long as the dynamic type
-supports equality).  Structs, arrays and slices cannot be used as map keys,
-because equality is not defined on those types.
+strings, pointers, interfaces (as long as the dynamic type
+supports equality), structs and arrays. Slices cannot be used as map keys,
+because equality is not defined on them.
 Like slices, maps are a reference type. If you pass a map to a function
 that changes the contents of the map, the changes will be visible
 in the caller.
@@ -1452,7 +1452,7 @@ fmt.Println(fmt.Sprint("Hello ", 23))
 

As mentioned in -the Tour, fmt.Fprint +the Tour, fmt.Fprint and friends take as a first argument any object that implements the io.Writer interface; the variables os.Stdout and os.Stderr are familiar instances. @@ -1920,7 +1920,7 @@ A similar approach allows the streaming cipher algorithms in the various crypto packages to be separated from the block ciphers they chain together. The Block interface -in the crypto/cipherpackage specifies the +in the crypto/cipher package specifies the behavior of a block cipher, which provides encryption of a single block of data. Then, by analogy with the bufio package, @@ -2331,7 +2331,7 @@ it can also be seen as a type-safe generalization of Unix pipes. They're called goroutines because the existing terms—threads, coroutines, processes, and so on—convey inaccurate connotations. A goroutine has a simple model: it is a -function executing in parallel with other goroutines in the same +function executing concurrently with other goroutines in the same address space. It is lightweight, costing little more than the allocation of stack space. And the stacks start small, so they are cheap, and grow @@ -2352,7 +2352,7 @@ exits, silently. (The effect is similar to the Unix shell's background.)

-go list.Sort()  // run list.Sort in parallel; don't wait for it. 
+go list.Sort()  // run list.Sort concurrently; don't wait for it. 
 

A function literal can be handy in a goroutine invocation. @@ -2697,14 +2697,14 @@ it is much more informative than the plain

When feasible, error strings should identify their origin, such as by having a prefix naming the package that generated the error. For example, in package -image, the string representation for a decoding error due to an unknown format -is "image: unknown format". +image, the string representation for a decoding error due to an +unknown format is "image: unknown format".

Callers that care about the precise error details can use a type switch or a type assertion to look for specific -errors and extract details. For PathErrors +errors and extract details. For PathErrors this might include examining the internal Err field for recoverable failures.

@@ -2985,7 +2985,7 @@ for safe display on the web page.

The rest of the template string is just the HTML to show when the page loads. -If this is too quick an explanation, see the documentation +If this is too quick an explanation, see the documentation for the template package for a more thorough discussion.