Skip to content
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.

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

crypto/x509: typo in docs for x509.CreateCertificateRequest #14649

Closed
voutasaurus opened this issue Mar 4, 2016 · 3 comments
Closed

crypto/x509: typo in docs for x509.CreateCertificateRequest #14649

voutasaurus opened this issue Mar 4, 2016 · 3 comments

Comments

@voutasaurus
Copy link

@voutasaurus voutasaurus commented Mar 4, 2016

Please answer these questions before submitting your issue. Thanks!

  1. What version of Go are you using (go version)?
    go version go1.6 darwin/amd64
  2. What operating system and processor architecture are you using (go env)?
    GOARCH="amd64"
    GOOS="darwin"
  3. What did you do?
    (Use play.golang.org to provide a runnable example, if possible.)
    Read https://golang.org/pkg/crypto/x509/#CreateCertificateRequest
  4. What did you expect to see?
    "CreateCertificateRequest creates a new certificate request based on a template."
  5. What did you see instead?
    "CreateCertificateRequest creates a new certificate based on a template."

This was really confusing for a minute because there is currently no exposed function in x509 that creates a certificate from a request, but that sentence implies that's what CreateCertificateRequest does, even though the name of the function makes it sort of obvious that's not what it does.

@ianlancetaylor ianlancetaylor changed the title Typo in docs for x509.CreateCertificateRequest crypto/x509: typo in docs for x509.CreateCertificateRequest Mar 4, 2016
@ianlancetaylor ianlancetaylor added this to the Go1.7 milestone Mar 4, 2016
@ianlancetaylor
Copy link
Contributor

@ianlancetaylor ianlancetaylor commented Mar 4, 2016

CC @agl

(I would fix it but I really don't understand this stuff.)

@rsc
Copy link
Contributor

@rsc rsc commented May 18, 2016

I do understand this one detail and I confirm that
"CreateCertificateRequest creates a new certificate based on a template."
should instead be
"CreateCertificateRequest creates a new certificate request based on a template."

If someone creates the CL, LGTM.

@gopherbot
Copy link

@gopherbot gopherbot commented May 18, 2016

CL https://golang.org/cl/23204 mentions this issue.

@gopherbot gopherbot closed this in ac66bb3 May 18, 2016
@golang golang locked and limited conversation to collaborators May 18, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.