protoc-gen-go-grpc: update README to clarify --go-grpc_opt
#7825
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #7825 +/- ##
==========================================
+ Coverage 81.91% 81.98% +0.07%
==========================================
Files 377 377
Lines 38065 38065
==========================================
+ Hits 31180 31208 +28
+ Misses 5581 5558 -23
+ Partials 1304 1299 -5 |
arjan-bal
added
Type: Documentation
purnesh42H
reviewed
Nov 16, 2024
cmd/protoc-gen-go-grpc/README.md
Outdated
| @@ -17,6 +17,10 @@ E.g.: | |||
| protoc --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false[,other options...] \ | |||
| ``` | |||
|
|
|||
| **Using of --go-grpc_out and --go-grpc_opt** | |||
There was a problem hiding this comment.
@hanut19 you don't have to document go-grpc_out and go-grpc_opt for this task
cmd/protoc-gen-go-grpc/README.md
Outdated
| @@ -17,6 +17,10 @@ E.g.: | |||
| protoc --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false[,other options...] \ | |||
There was a problem hiding this comment.
the issue ask to make this statement more readable since we have gotten multiple complaints to be confused by this
There was a problem hiding this comment.
Something like this
protoc --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false \
--go-grpc_opt=[other options...]
There was a problem hiding this comment.
this suggestion won't work. both flags shouldn't be same. I meant the other one to be --go_opt
hanut19
force-pushed
the
document-updation-proto-gen-go-grpc-readme
branch
from
9b4666d
to
9f6e45a
Compare
purnesh42H
changed the title
--go-grpc_opt
purnesh42H
reviewed
Nov 19, 2024
cmd/protoc-gen-go-grpc/README.md
Outdated
| @@ -14,7 +14,8 @@ To restore this behavior, set the option `require_unimplemented_servers=false`. | |||
| E.g.: | |||
|
|
|||
| ```sh | |||
| protoc --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false[,other options...] \ | |||
| protoc --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false \ | |||
purnesh42H
reviewed
Nov 19, 2024
cmd/protoc-gen-go-grpc/README.md
Outdated
| @@ -14,7 +14,8 @@ To restore this behavior, set the option `require_unimplemented_servers=false`. | |||
| E.g.: | |||
|
|
|||
| ```sh | |||
| protoc --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false[,other options...] \ | |||
| protoc --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false \ | |||
| --go-grpc_opt=[other options...] | |||
There was a problem hiding this comment.
need \ at the end and everything can be in single line
hanut19
force-pushed
the
document-updation-proto-gen-go-grpc-readme
branch
from
9f6e45a
to
2032c3c
Compare
purnesh42H
reviewed
Nov 26, 2024
| @@ -14,7 +14,8 @@ To restore this behavior, set the option `require_unimplemented_servers=false`. | |||
| E.g.: | |||
|
|
|||
| ```sh | |||
| protoc --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false[,other options...] \ | |||
| protoc --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false \ | |||
|
@hanut19 i will close this PR for now since it is actually fixed. I have asked Doug in the issue if we should actually delete this section. If yes, you can open a separate PR to delete the section. |
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.
Address: #5651
RELEASE NOTES: None