Add --omit_package_doc flag #1702
Merged
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
Makes it possible to omit the package comment from generated code. This is useful if the generated code is added to an existing package that already has package documentation (the generated package comment might be misleading in that case). Co-authored-by: olivierlemasle <[email protected]>
johanbrandhorst
approved these changes
Sep 28, 2020
|
Not sure how the Google CLA bot didn't react to this, but @RJPercival could you please give consent for this to be merged since it's based on your original PR? |
|
It might be because I'm a xoogler. I'm happy for this to be merged 👍 |
|
Thanks for your contribution! Could you please cherry-pick this against v2? |
olivierlemasle
added a commit
to olivierlemasle/grpc-gateway
that referenced
this pull request
Sep 28, 2020
Makes it possible to omit the package comment from generated code. This is useful if the generated code is added to an existing package that already has package documentation (the generated package comment might be misleading in that case). Co-authored-by: olivierlemasle <[email protected]> Co-authored-by: Rob Percival <[email protected]>
johanbrandhorst
pushed a commit
that referenced
this pull request
Sep 28, 2020
Makes it possible to omit the package comment from generated code. This is useful if the generated code is added to an existing package that already has package documentation (the generated package comment might be misleading in that case). Co-authored-by: olivierlemasle <[email protected]> Co-authored-by: Rob Percival <[email protected]>
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.
References to other Issues or PRs
Fixes #1701
Have you read the Contributing Guidelines?
Yes
Brief description of what is fixed or changed
Add an option
-omit_package_docto omit the package comment from generated code in gRPC gateway. This is useful if the generated code is added to an existing package that already has package documentation (the generated package comment might be misleading in that case).Other comments
This is a rebased re-openening of #1103.