feat(gengapic): add in-line snippet comment to example.go #1120
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
noahdietz
approved these changes
Sep 1, 2022
codyoss
reviewed
Sep 1, 2022
| @@ -64,6 +64,11 @@ func (g *generator) exampleInitClient(pkgName, servName string) { | |||
| p := g.printf | |||
|
|
|||
| p("ctx := context.Background()") | |||
| p("// This snippet has been automatically generated and should be regarded as a code template only.") | |||
There was a problem hiding this comment.
Suggested change
| p("// This snippet has been automatically generated and should be regarded as a code template only.") | |
| p("// This code has been automatically generated and should be regarded as a template only.") |
Make this more vague I think. This also will appear as godoc examples and the term snippet has no meaning there.
There was a problem hiding this comment.
Unfortunately the exact wording is spec'd, I think it's better to stick with it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See b/240118237 for requirements.
See also: