diff options
| author | Alberto Donizetti <alb.donizetti@gmail.com> | 2018-07-11 10:32:06 +0200 |
|---|---|---|
| committer | Alberto Donizetti <alb.donizetti@gmail.com> | 2018-07-11 14:14:13 +0000 |
| commit | 09117631137a3fa40cb8194e349620b2c77a1ff0 (patch) | |
| tree | 63deec1c948dd6c903d7208fe522fd4a3a393f11 | |
| parent | 8bf7e083063e016e10c1d369645882a676870786 (diff) | |
| download | golang-id-tour-09117631137a3fa40cb8194e349620b2c77a1ff0.tar.xz | |
tour: uniform the use of bold for Notes
A few tour slides end with a Note with some additional remarks. Most
of the times the word "Note:" is in bold, and the next word is
capitalized, except in a few places. Uniform the style by making it
always bold and by always capitalizing the sentence.
Change-Id: Ib5843a55c0e9a4f602efa0346f96702493a7284a
Reviewed-on: https://go-review.googlesource.com/123215
Reviewed-by: Andrew Bonventre <andybons@golang.org>
| -rw-r--r-- | content/basics.article | 2 | ||||
| -rw-r--r-- | content/concurrency.article | 2 | ||||
| -rw-r--r-- | content/flowcontrol.article | 4 | ||||
| -rw-r--r-- | content/methods.article | 2 | ||||
| -rw-r--r-- | content/moretypes.article | 2 |
5 files changed, 6 insertions, 6 deletions
diff --git a/content/basics.article b/content/basics.article index 528eaf1..082a6ab 100644 --- a/content/basics.article +++ b/content/basics.article @@ -14,7 +14,7 @@ This program is using the packages with import paths `"fmt"` and `"math/rand"`. By convention, the package name is the same as the last element of the import path. For instance, the `"math/rand"` package comprises files that begin with the statement `package`rand`. -#appengine: *Note:* the environment in which these programs are executed is +#appengine: *Note:* The environment in which these programs are executed is #appengine: deterministic, so each time you run the example program #appengine: `rand.Intn` will return the same number. #appengine: diff --git a/content/concurrency.article b/content/concurrency.article index 913c727..b6bd509 100644 --- a/content/concurrency.article +++ b/content/concurrency.article @@ -65,7 +65,7 @@ The loop `for`i`:=`range`c` receives values from the channel repeatedly until it *Note:* Only the sender should close a channel, never the receiver. Sending on a closed channel will cause a panic. -*Another*note*: Channels aren't like files; you don't usually need to close them. Closing is only necessary when the receiver must be told there are no more values coming, such as to terminate a `range` loop. +*Another*note:* Channels aren't like files; you don't usually need to close them. Closing is only necessary when the receiver must be told there are no more values coming, such as to terminate a `range` loop. .play concurrency/range-and-close.go diff --git a/content/flowcontrol.article b/content/flowcontrol.article index a67d7ec..c8bcd5c 100644 --- a/content/flowcontrol.article +++ b/content/flowcontrol.article @@ -20,7 +20,7 @@ statement. The loop will stop iterating once the boolean condition evaluates to `false`. -_Note_: Unlike other languages like C, Java, or JavaScript there are no parentheses +*Note:* Unlike other languages like C, Java, or JavaScript there are no parentheses surrounding the three components of the `for` statement and the braces `{`}` are always required. @@ -102,7 +102,7 @@ See if that's more or fewer than 10 iterations. Try other initial guesses for z, like x, or x/2. How close are your function's results to the [[https://golang.org/pkg/math/#Sqrt][math.Sqrt]] in the standard library? -(Note: If you are interested in the details of the algorithm, the z² − x above +(*Note:* If you are interested in the details of the algorithm, the z² − x above is how far away z² is from where it needs to be (x), and the division by 2z is the derivative of z², to scale how much we adjust z by how quickly z² is changing. This general approach is called [[https://en.wikipedia.org/wiki/Newton%27s_method][Newton's method]]. diff --git a/content/methods.article b/content/methods.article index 5ad5cc8..83c9d7a 100644 --- a/content/methods.article +++ b/content/methods.article @@ -332,7 +332,7 @@ and make it an `error` by giving it a method such that `ErrNegativeSqrt(-2).Error()` returns `"cannot`Sqrt`negative`number:`-2"`. -*Note:* a call to `fmt.Sprint(e)` inside the `Error` method will send the program into an infinite loop. You can avoid this by converting `e` first: `fmt.Sprint(float64(e))`. Why? +*Note:* A call to `fmt.Sprint(e)` inside the `Error` method will send the program into an infinite loop. You can avoid this by converting `e` first: `fmt.Sprint(float64(e))`. Why? Change your `Sqrt` function to return an `ErrNegativeSqrt` value when given a negative number. diff --git a/content/moretypes.article b/content/moretypes.article index 2840489..955214e 100644 --- a/content/moretypes.article +++ b/content/moretypes.article @@ -309,7 +309,7 @@ If `key` is in `m`, `ok` is `true`. If not, `ok` is `false`. If `key` is not in the map, then `elem` is the zero value for the map's element type. -_Note_: if `elem` or `ok` have not yet been declared you could use a short declaration form: +*Note:* If `elem` or `ok` have not yet been declared you could use a short declaration form: elem, ok := m[key] |
