From: Brett Cannon <bcannon@gmail.com>
Date: Fri, 8 May 2015 14:41:15 +0000 (-0400)
Subject: doc/effective_go: make function signature match function body
X-Git-Tag: go1.5beta1~675
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=3a3773c8cb439034094025cf2f85ed52535c3e1f;p=gostls13.git

doc/effective_go: make function signature match function body

In the Slices section of Effective Go, the os package's File.Read
function is used as an example. Unfortunately the function signature
does not match the function's code in the example, nor the os package's
documentation. This change updates the function signature to match
the os package and the pre-existing function code.

Change-Id: Iae9f30c898d3a1ff8d47558ca104dfb3ff07112c
Reviewed-on: https://go-review.googlesource.com/9845
Reviewed-by: Rob Pike <r@golang.org>
---

diff --git a/doc/effective_go.html b/doc/effective_go.html
index d6be37994b..8a827d0433 100644
--- a/doc/effective_go.html
+++ b/doc/effective_go.html
@@ -1382,7 +1382,7 @@ limit of how much data to read.  Here is the signature of the
 <code>os</code>:
 </p>
 <pre>
-func (file *File) Read(buf []byte) (n int, err error)
+func (f *File) Read(buf []byte) (n int, err error)
 </pre>
 <p>
 The method returns the number of bytes read and an error value, if