code review 6457085: crypto/rand: Example for Read.

crypto/rand: Example for Read.

[nictuku, 2012-08-06 20:25:49]

Hello adg (cc: golang-dev@googlegroups.com),

I'd like you to review this change to
https://code.google.com/p/go

[remyoudompheng, 2012-08-06 20:27:02]

http://codereview.appspot.com/6457085/diff/5001/src/pkg/crypto/rand/example_t...
File src/pkg/crypto/rand/example_test.go (right):

http://codereview.appspot.com/6457085/diff/5001/src/pkg/crypto/rand/example_t...
src/pkg/crypto/rand/example_test.go:28: fmt.Println(reflect.DeepEqual(b,
make([]byte, count)))
i think a user-oriented example should use bytes.Equal and not the reflect
package.

[rsc, 2012-08-06 20:29:54]

The example should use io.ReadFull.

[nictuku, 2012-08-06 20:29:56]

On Mon, Aug 6, 2012 at 10:27 PM,  <remyoudompheng@gmail.com> wrote:
>
>
http://codereview.appspot.com/6457085/diff/5001/src/pkg/crypto/rand/example_t...
> File src/pkg/crypto/rand/example_test.go (right):
>
>
http://codereview.appspot.com/6457085/diff/5001/src/pkg/crypto/rand/example_t...
> src/pkg/crypto/rand/example_test.go:28: fmt.Println(reflect.DeepEqual(b,
> make([]byte, count)))
> i think a user-oriented example should use bytes.Equal and not the
> reflect package.

Thanks, I was just going to ask for better ways to do that. I didn't
know about bytes.Equal. Changing now.

Also, I'm undecided if the for loop is a good idea - it's correct, but
also slightly complicated. Suggestions are welcomed.

-- 
Yves Junqueira <http://cetico.org/about>

[nictuku, 2012-08-06 20:42:37]

Please have another look.

I also tried to change from ExampleRead() to ExampleReader() which
seemed more appropriate, but godoc doesn't seem to display examples
for variables properly - even though the "Examples" section is shown
in the page index, the content is not displayed.

I left it as ExampleRead(). Let me know if it should be
ExampleReader() and if I should go fix godoc.

[r, 2012-08-07 03:44:27]

http://codereview.appspot.com/6457085/diff/11001/src/pkg/crypto/rand/example_...
File src/pkg/crypto/rand/example_test.go (right):

http://codereview.appspot.com/6457085/diff/11001/src/pkg/crypto/rand/example_...
src/pkg/crypto/rand/example_test.go:14: func ExampleRead() {
there should be a comment here.

[nictuku, 2012-08-08 01:25:14]

http://codereview.appspot.com/6457085/diff/11001/src/pkg/crypto/rand/example_...
File src/pkg/crypto/rand/example_test.go (right):

http://codereview.appspot.com/6457085/diff/11001/src/pkg/crypto/rand/example_...
src/pkg/crypto/rand/example_test.go:14: func ExampleRead() {
On 2012/08/07 03:44:27, r wrote:
> there should be a comment here.

Done.

[adg, 2012-08-08 01:40:52]

LGTM

[adg, 2012-08-08 02:05:02]

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

crypto/rand: Example for Read.

R=adg, remyoudompheng, rsc, r
CC=golang-dev
http://codereview.appspot.com/6457085

Committer: Andrew Gerrand <adg@golang.org>