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

blog: document Code generated convention in the Generating code blog post #20720

Closed
mewmew opened this issue Jun 18, 2017 · 6 comments
Closed
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@mewmew
Copy link
Contributor

mewmew commented Jun 18, 2017

As the Go community has reached consensus on the convention to use for distinguishing machine-generated code (i.e. https://golang.org/s/generatedcode), it would be good if the Generating code article on the Go blog was updated to reflect this. Preferably a link could also be added from the Generating code article to https://golang.org/s/generatedcode

In particular, the Generating code article is still using the convention // generated by stringer -type Pill pill.go; DO NOT EDIT. Since the blog post is the first hit (for me at least) on Google which searching for generate code golang, the article should in my opinion be updated so that new Gophers learn the newly established convention.

@bradfitz bradfitz added this to the Unreleased milestone Jun 18, 2017
@bradfitz bradfitz added the NeedsFix The path to resolution is known, but the work has not been done. label Jun 18, 2017
@bradfitz
Copy link
Contributor

Sounds good. Feel free to send.

But I wouldn't link to https://golang.org/s/generatedcode, at least until we have a better target URL for that shortlink.

@mewmew
Copy link
Contributor Author

mewmew commented Jun 18, 2017

Ok, I'll skip adding the link, but will send a CL for

-// generated by stringer -type Pill pill.go; DO NOT EDIT
+// Code generated by stringer -type Pill pill.go; DO NOT EDIT.

@bradfitz How far away is maintner from being able to convert GitHub pull requests to Gerrit CLs? I'd be happy to beta-test ;)

@bradfitz
Copy link
Contributor

Far.

@agnivade
Copy link
Contributor

@mewmew - PRs work now. Want to send one ?

@mewmew
Copy link
Contributor Author

mewmew commented Mar 15, 2019

@mewmew - PRs work now. Want to send one ?

@agnivade Done :)

@gopherbot
Copy link

Change https://golang.org/cl/167763 mentions this issue: blog: update code sample in the "Generating code" article

@golang golang locked and limited conversation to collaborators Mar 15, 2020
gopherbot pushed a commit to golang/website that referenced this issue May 26, 2021
Fixes golang/go#20720.

Change-Id: Iabeadddba92d6d51f873d817446eb79f20694be6
GitHub-Last-Rev: bd9501d806e08aff6cf230d1490fee14e2ba5e6f
GitHub-Pull-Request: golang/blog#20
Reviewed-on: https://go-review.googlesource.com/c/blog/+/167763
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
X-Blog-Commit: 933f9aa4742a8ce65b9b4e3c4c7226744d3adb2e
passionSeven added a commit to passionSeven/website that referenced this issue Oct 18, 2022
Fixes golang/go#20720.

Change-Id: Iabeadddba92d6d51f873d817446eb79f20694be6
GitHub-Last-Rev: bd9501d806e08aff6cf230d1490fee14e2ba5e6f
GitHub-Pull-Request: golang/blog#20
Reviewed-on: https://go-review.googlesource.com/c/blog/+/167763
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
X-Blog-Commit: 933f9aa4742a8ce65b9b4e3c4c7226744d3adb2e
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

4 participants