code review 11697043: all: change "true iff" to "whether" in public docs

all: change "true iff" to "whether" in public docs

For consistency with Go documentation style.

[bradfitz, 2013-07-22 22:33:39]

Hello golang-dev@googlegroups.com,

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

[khr1, 2013-07-22 22:39:28]

LGTM.


On Mon, Jul 22, 2013 at 3:33 PM, <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:
> all: change "true iff" to "whether" in public docs
>
> For consistency with Go documentation style.
>
> Please review this at
https://codereview.appspot.**com/11697043/<https://codereview.appspot.com/116...
>
> Affected files:
>   M src/pkg/crypto/ecdsa/ecdsa.go
>   M src/pkg/crypto/x509/pkix/pkix.**go
>   M src/pkg/encoding/asn1/asn1.go
>
>
> Index: src/pkg/crypto/ecdsa/ecdsa.go
> ==============================**==============================**=======
> --- a/src/pkg/crypto/ecdsa/ecdsa.**go
> +++ b/src/pkg/crypto/ecdsa/ecdsa.**go
> @@ -124,7 +124,7 @@
>  }
>
>  // Verify verifies the signature in r, s of hash using the public key,
> pub. It
> -// returns true iff the signature is valid.
> +// returns whether the signature is valid.
>  func Verify(pub *PublicKey, hash []byte, r, s *big.Int) bool {
>         // See [NSA] 3.4.2
>         c := pub.Curve
> Index: src/pkg/crypto/x509/pkix/pkix.**go
> ==============================**==============================**=======
> --- a/src/pkg/crypto/x509/pkix/**pkix.go
> +++ b/src/pkg/crypto/x509/pkix/**pkix.go
> @@ -144,7 +144,7 @@
>         SignatureValue     asn1.BitString
>  }
>
> -// HasExpired returns true iff now is past the expiry time of certList.
> +// HasExpired returns whether now is past the expiry time of certList.
>  func (certList *CertificateList) HasExpired(now time.Time) bool {
>         return now.After(certList.**TBSCertList.NextUpdate)
>  }
> Index: src/pkg/encoding/asn1/asn1.go
> ==============================**==============================**=======
> --- a/src/pkg/encoding/asn1/asn1.**go
> +++ b/src/pkg/encoding/asn1/asn1.**go
> @@ -183,7 +183,7 @@
>  // An ObjectIdentifier represents an ASN.1 OBJECT IDENTIFIER.
>  type ObjectIdentifier []int
>
> -// Equal returns true iff oi and other represent the same identifier.
> +// Equal returns whether oi and other represent the same identifier.
>  func (oi ObjectIdentifier) Equal(other ObjectIdentifier) bool {
>         if len(oi) != len(other) {
>                 return false
>
>
> --
>
> ---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<golang-dev%2Bunsubscribe@googlegrou...
> .
> For more options, visit
https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/o...
> .
>
>
>

[bradfitz, 2013-07-22 23:20:36]

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

all: change "true iff" to "whether" in public docs

For consistency with Go documentation style.

R=golang-dev, khr
CC=golang-dev
https://codereview.appspot.com/11697043

[rsc, 2013-07-22 23:27:41]

The official wording is "reports whether" not "returns whether". I never
bothered to clean things up, but if you're going to do a cleanup, please
use "reports whether".

[bradfitz, 2013-07-22 23:51:41]

Gotcha.

Those were the only 3 public "iff".  At least it's more consistent now,
with only 2 ways to say it, instead of 3.

$ grep -r "reports whether" * | wc -l
     113
$ grep -r "returns whether" * | wc -l
      82

Changing all the returns to reports would be a larger CL. Your call. I
doubt it's worth the churn.




On Mon, Jul 22, 2013 at 4:27 PM, Russ Cox <rsc@golang.org> wrote:

> The official wording is "reports whether" not "returns whether". I never
> bothered to clean things up, but if you're going to do a cleanup, please
> use "reports whether".
>
>
>

[rsc, 2013-07-22 23:52:42]

At some point we should probably do it. I don't much care when. Maybe
during the Go 1.2 freeze.

[r, 2013-07-23 00:04:50]

It returns always, it doesn't return whether some property. I'm happy to see you
remove the iff, but these should say "reports whether" not "returns whether". I
will fix.

[bradfitz, 2013-07-23 00:15:27]

I guess.

I can also read it as "returns" being a verb (always) and the rest being
what it returns.

If I said, "I want to know whether you picked up the coffee.", then I'm
still interested (in knowing) even if you didn't pick up the coffee.

But since you care either way and know the grammars, I'll happily let you
make the change.  :-)



On Mon, Jul 22, 2013 at 5:04 PM, <r@golang.org> wrote:

> It returns always, it doesn't return whether some property. I'm happy to
> see you remove the iff, but these should say "reports whether" not
> "returns whether". I will fix.
>
>
>
https://codereview.appspot.**com/11697043/<https://codereview.appspot.com/116...
>