Skip to content

crypto/hmac: rename CheckHMAC to ValidHMAC in package docs #28823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

crypto/hmac: rename CheckHMAC to ValidHMAC in package docs #28823

wants to merge 1 commit into from

Conversation

sevki
Copy link
Contributor

@sevki sevki commented Nov 16, 2018 •
edited by FiloSottile
Loading

Procedure names should reflect what they do; function names
should reflect what they return. Functions are used in
expressions, often in things like if's, so they need
to read appropriately.

    if CheckHMAC(a, b, key)

is unhelpful because we can't deduce whether CheckHMAC
returns true on error or non­-error; instead

    if ValidHMAC(a, b, key)

makes the point clear and makes a future mistake
in using the routine less likely.

https://www.lysator.liu.se/c/pikestyle.html

@sevki
crypto/hmac: change checkhmac to validhmac
32199a4 
Procedure names should reflect what they do; function names
should reflect what they return. Functions are used in
expressions, often in things like if's, so they need
to read appropriately.

        if CheckHMAC(a,b, key)

is unhelpful because we can't deduce whether CheckHMAC
returns true on error or non­error;instead

        if ValidHMAC(x)

https://www.lysator.liu.se/c/pikestyle.html

makes the point clear and makes a future mistake in using the routine less likely.
@googlebot googlebot added the cla: yes Used by googlebot to label PRs as having a valid CLA. The text of this label should not change. label Nov 16, 2018
@gopherbot
Copy link
Contributor

This PR (HEAD: 32199a4) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/go/+/149857 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@gopherbot
Copy link
Contributor

Message from Gobot Gobot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
Within the next week or so, a maintainer will review your change and provide
feedback. See https://golang.org/doc/contribute.html#review for more info and
tips to get your patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

During May-July and Nov-Jan the Go project is in a code freeze, during which
little code gets reviewed or merged. If a reviewer responds with a comment like
R=go1.11, it means that this CL will be reviewed as part of the next development
cycle. See https://golang.org/s/release for more details.

Please don’t reply on this GitHub thread. Visit golang.org/cl/149857.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Sevki Hasirci:

Uploaded patch set 2: Commit message was updated.

Please don’t reply on this GitHub thread. Visit golang.org/cl/149857.
After addressing review feedback, remember to publish your drafts!

@FiloSottile FiloSottile changed the title crypto/hmac: change checkhmac to validhmac crypto/hmac: rename CheckHMAC to ValidHMAC in package docs Nov 17, 2018
@gopherbot
Copy link
Contributor

Message from Filippo Valsorda:

Patch Set 5: Code-Review+2

Thanks for your PR! I edited the title to clarify that it's changing the docs, not an exposed API, as I was about to reject this due to the Go 1 compatibility promise :)

Please don’t reply on this GitHub thread. Visit golang.org/cl/149857.
After addressing review feedback, remember to publish your drafts!

gopherbot pushed a commit that referenced this pull request Nov 17, 2018
@sevki @FiloSottile
crypto/hmac: rename CheckHMAC to ValidHMAC in package docs
054640b 
Procedure names should reflect what they do; function names
should reflect what they return. Functions are used in
expressions, often in things like if's, so they need
to read appropriately.

        if CheckHMAC(a, b, key)

is unhelpful because we can't deduce whether CheckHMAC
returns true on error or non­-error; instead

        if ValidHMAC(a, b, key)

makes the point clear and makes a future mistake
in using the routine less likely.

https://www.lysator.liu.se/c/pikestyle.html

Change-Id: I7c4b1981c90c8d7475ddd8ec18dee3db2e0f42df
GitHub-Last-Rev: 32199a4
GitHub-Pull-Request: #28823
Reviewed-on: https://go-review.googlesource.com/c/149857
Reviewed-by: Filippo Valsorda <[email protected]>
@gopherbot
Copy link
Contributor

This PR is being closed because golang.org/cl/149857 has been merged.

@gopherbot gopherbot closed this Nov 17, 2018
bradfitz pushed a commit that referenced this pull request Nov 21, 2018
@sevki @FiloSottile
crypto/hmac: rename CheckHMAC to ValidHMAC in package docs
5001a38 
Procedure names should reflect what they do; function names
should reflect what they return. Functions are used in
expressions, often in things like if's, so they need
to read appropriately.

        if CheckHMAC(a, b, key)

is unhelpful because we can't deduce whether CheckHMAC
returns true on error or non­-error; instead

        if ValidHMAC(a, b, key)

makes the point clear and makes a future mistake
in using the routine less likely.

https://www.lysator.liu.se/c/pikestyle.html

Change-Id: I7c4b1981c90c8d7475ddd8ec18dee3db2e0f42df
GitHub-Last-Rev: 32199a4
GitHub-Pull-Request: #28823
Reviewed-on: https://go-review.googlesource.com/c/149857
Reviewed-by: Filippo Valsorda <[email protected]>
JackOfMostTrades pushed a commit to JackOfMostTrades/go-crypto that referenced this pull request Feb 3, 2019
@sevki @FiloSottile
crypto/hmac: rename CheckHMAC to ValidHMAC in package docs
a2d844a 
Procedure names should reflect what they do; function names
should reflect what they return. Functions are used in
expressions, often in things like if's, so they need
to read appropriately.

        if CheckHMAC(a, b, key)

is unhelpful because we can't deduce whether CheckHMAC
returns true on error or non­-error; instead

        if ValidHMAC(a, b, key)

makes the point clear and makes a future mistake
in using the routine less likely.

https://www.lysator.liu.se/c/pikestyle.html

Change-Id: I7c4b1981c90c8d7475ddd8ec18dee3db2e0f42df
GitHub-Last-Rev: 32199a418b5e5507259fa4b6715da8a9c185f90a
GitHub-Pull-Request: golang/go#28823
Reviewed-on: https://go-review.googlesource.com/c/149857
Reviewed-by: Filippo Valsorda <[email protected]>
bassosimone pushed a commit to ooni/oocrypto that referenced this pull request May 21, 2022
@sevki @FiloSottile
crypto/hmac: rename CheckHMAC to ValidHMAC in package docs
e430aa8 
Procedure names should reflect what they do; function names
should reflect what they return. Functions are used in
expressions, often in things like if's, so they need
to read appropriately.

        if CheckHMAC(a, b, key)

is unhelpful because we can't deduce whether CheckHMAC
returns true on error or non­-error; instead

        if ValidHMAC(a, b, key)

makes the point clear and makes a future mistake
in using the routine less likely.

https://www.lysator.liu.se/c/pikestyle.html

Change-Id: I7c4b1981c90c8d7475ddd8ec18dee3db2e0f42df
GitHub-Last-Rev: 32199a418b5e5507259fa4b6715da8a9c185f90a
GitHub-Pull-Request: golang/go#28823
Reviewed-on: https://go-review.googlesource.com/c/149857
Reviewed-by: Filippo Valsorda <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
cla: yes Used by googlebot to label PRs as having a valid CLA. The text of this label should not change.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sevki @gopherbot @googlebot