code review 12983045: bytes: clarify Equal docs

bytes: clarify Equal docs

== isn't defined on slices, so don't use it in docs.

[bradfitz, 2013-08-24 19:04:41]

Hello golang-dev@googlegroups.com,

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

[iant, 2013-08-24 19:40:35]

LGTM

[bradfitz, 2013-08-24 22:05:30]

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

bytes: clarify Equal docs

== isn't defined on slices, so don't use it in docs.

R=golang-dev, iant
CC=golang-dev
https://codereview.appspot.com/12983045

[dave_cheney.net, 2013-08-25 01:03:27]

LGTM. 



On 25/08/2013, at 5:04, bradfitz@golang.org wrote:

> Reviewers: golang-dev1,
> 
> Message:
> Hello golang-dev@googlegroups.com,
> 
> I'd like you to review this change to
> https://go.googlecode.com/hg/
> 
> 
> Description:
> bytes: clarify Equal docs
> 
> == isn't defined on slices, so don't use it in docs.
> 
> Please review this at https://codereview.appspot.com/12983045/
> 
> Affected files:
>  M src/pkg/bytes/bytes_decl.go
> 
> 
> Index: src/pkg/bytes/bytes_decl.go
> ===================================================================
> --- a/src/pkg/bytes/bytes_decl.go
> +++ b/src/pkg/bytes/bytes_decl.go
> @@ -11,7 +11,8 @@
> 
> //go:noescape
> 
> -// Equal returns a boolean reporting whether a == b.
> +// Equal returns a boolean reporting whether a and b
> +// are the same length and contain the same bytes.
> // A nil argument is equivalent to an empty slice.
> func Equal(a, b []byte) bool // ../runtime/asm_$GOARCH.s
> 
> 
> 
> -- 
> 
> ---You received this message because you are subscribed to the Google Groups
"golang-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an
email to golang-dev+unsubscribe@googlegroups.com.
> For more options, visit https://groups.google.com/groups/opt_out.

[r, 2013-08-25 01:28:04]

https://codereview.appspot.com/12983045/diff/11001/src/pkg/bytes/bytes_decl.go
File src/pkg/bytes/bytes_decl.go (right):

https://codereview.appspot.com/12983045/diff/11001/src/pkg/bytes/bytes_decl.g...
src/pkg/bytes/bytes_decl.go:15: // are the same length and contain the same
bytes.
this is clear enough i suppose but "ab" and "ba" contain the same bytes.
too pedantic a distinction to worry about, though; the name "Equal" says enough.