code review 4675070: tutorial: remove all line numbers and references to them.

tutorial: remove all line numbers and references to them.

[r, 2011-07-09 10:16:03]

Hello golang-dev@googlegroups.com,

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

[mikio, 2011-07-09 12:36:15]

LGTM

On Sat, Jul 9, 2011 at 7:16 PM,  <r@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:
> tutorial: remove all line numbers and references to them.
>
> Please review this at http://codereview.appspot.com/4675070/
>
> Affected files:
>  M doc/go_tutorial.html
>  M doc/go_tutorial.txt
>
>
> Index: doc/go_tutorial.html
> ===================================================================
> --- a/doc/go_tutorial.html
> +++ b/doc/go_tutorial.html
> @@ -19,9 +19,6 @@
>  key features of the language.  All the programs work (at time of writing)
> and are
>  checked into the repository in the directory <a
> href='/doc/progs'><code>/doc/progs/</code></a>.
>  <p>
> -Program snippets are annotated with the line number in the original file;
> for
> -cleanliness, blank lines remain blank.
> -<p>
>  <h2>Hello, World</h2>
>  <p>
>  Let's start in the usual way:
> @@ -176,12 +173,13 @@
>  <p>
>  Given <code>os.Stdout</code> we can use its <code>WriteString</code> method
> to print the string.
>  <p>
> -Having imported the <code>flag</code> package, line 12 creates a global
> variable to hold
> -the value of echo's <code>-n</code> flag. The variable
> <code>omitNewline</code> has type <code>*bool</code>, pointer
> -to <code>bool</code>.
> +After importing the <code>flag</code> package, we use a <code>var</code>
> declaration
> +to create and initialize a global variable, called
> <code>omitNewline</code>,
> +to hold the value of echo's <code>-n</code> flag.
> +The variable  has type <code>*bool</code>, pointer to <code>bool</code>.
>  <p>
> -In <code>main.main</code>, we parse the arguments (line 20) and then create
> a local
> -string variable we will use to build the output.
> +In <code>main.main</code>, we parse the arguments (the call to
> <code>flag.Parse</code>) and then create a local
> +string variable with which to build the output.
>  <p>
>  The declaration statement has the form
>  <p>
> @@ -540,7 +538,7 @@
>  </pre>
>  <p>
>  but for simple structures like <code>File</code> it's easier to return the
> address of a
> -composite literal, as is done here on line 21.
> +composite literal, as is done here in the <code>return</code>statement from
> <code>newFile</code>.
>  <p>
>  We can use the factory to construct some familiar, exported variables of
> type <code>*File</code>:
>  <p>
> @@ -573,9 +571,9 @@
>  they look just like a second parameter list.  The function
>  <code>syscall.Open</code>
>  also has a multi-value return, which we can grab with the multi-variable
> -declaration on line 31; it declares <code>r</code> and <code>e</code> to
> hold the two values,
> +declaration on the first line; it declares <code>r</code> and
> <code>e</code> to hold the two values,
>  both of type <code>int</code> (although you'd have to look at the
> <code>syscall</code> package
> -to see that).  Finally, line 35 returns two values: a pointer to the new
> <code>File</code>
> +to see that).  Finally, <code>OpenFile</code> returns two values: a pointer
> to the new <code>File</code>
>  and the error.  If <code>syscall.Open</code> fails, the file descriptor
> <code>r</code> will
>  be negative and <code>newFile</code> will return <code>nil</code>.
>  <p>
> Index: doc/go_tutorial.txt
> ===================================================================
> --- a/doc/go_tutorial.txt
> +++ b/doc/go_tutorial.txt
> @@ -20,9 +20,6 @@
>  key features of the language.  All the programs work (at time of writing)
> and are
>  checked into the repository in the directory <a
> href='/doc/progs'>"/doc/progs/"</a>.
>
> -Program snippets are annotated with the line number in the original file;
> for
> -cleanliness, blank lines remain blank.
> -
>  Hello, World
>  ----
>
> @@ -136,12 +133,13 @@
>
>  Given "os.Stdout" we can use its "WriteString" method to print the string.
>
> -Having imported the "flag" package, line 12 creates a global variable to
> hold
> -the value of echo's "-n" flag. The variable "omitNewline" has type "*bool",
> pointer
> -to "bool".
> +After importing the "flag" package, we use a "var" declaration
> +to create and initialize a global variable, called "omitNewline",
> +to hold the value of echo's "-n" flag.
> +The variable  has type "*bool", pointer to "bool".
>
> -In "main.main", we parse the arguments (line 20) and then create a local
> -string variable we will use to build the output.
> +In "main.main", we parse the arguments (the call to "flag.Parse") and then
> create a local
> +string variable with which to build the output.
>
>  The declaration statement has the form
>
> @@ -429,7 +427,7 @@
>        return n
>
>  but for simple structures like "File" it's easier to return the address of
> a
> -composite literal, as is done here on line 21.
> +composite literal, as is done here in the "return"statement from "newFile".
>
>  We can use the factory to construct some familiar, exported variables of
> type "*File":
>
> @@ -447,9 +445,9 @@
>  they look just like a second parameter list.  The function
>  "syscall.Open"
>  also has a multi-value return, which we can grab with the multi-variable
> -declaration on line 31; it declares "r" and "e" to hold the two values,
> +declaration on the first line; it declares "r" and "e" to hold the two
> values,
>  both of type "int" (although you'd have to look at the "syscall" package
> -to see that).  Finally, line 35 returns two values: a pointer to the new
> "File"
> +to see that).  Finally, "OpenFile" returns two values: a pointer to the new
> "File"
>  and the error.  If "syscall.Open" fails, the file descriptor "r" will
>  be negative and "newFile" will return "nil".
>
>
>
>

[dsymonds, 2011-07-09 13:04:34]

LGTM

http://codereview.appspot.com/4675070/diff/3001/doc/go_tutorial.html
File doc/go_tutorial.html (right):

http://codereview.appspot.com/4675070/diff/3001/doc/go_tutorial.html#newcode543
doc/go_tutorial.html:543: composite literal, as is done here in the
<code>return</code>statement from <code>newFile</code>.
missing space between </code> and statement.
also in the .txt file.

[r, 2011-07-09 13:17:49]

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

tutorial: remove all line numbers and references to them.

R=golang-dev, mikioh.mikioh, dsymonds
CC=golang-dev
http://codereview.appspot.com/4675070