chore: add comments to the platform.proto file #1641
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
thephez
requested review from
shumkov,
antouhou and
QuantumExplorer
as code owners
6 tasks
thephez
force-pushed
the
platform-proto-comments
branch
from
55806f5
to
3ddcc8a
Compare
|
@shumkov I rebased this so it can be merged. |
thephez
force-pushed
the
platform-proto-comments
branch
from
3ddcc8a
to
470b5e9
Compare
thephez
force-pushed
the
platform-proto-comments
branch
from
470b5e9
to
a9408ba
Compare
Co-authored-by: Ivan Shumkov <[email protected]>
thephez
force-pushed
the
platform-proto-comments
branch
from
a9408ba
to
c144cbe
Compare
shumkov
approved these changes
Jul 17, 2024
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.
Issue being fixed or feature implemented
The
platform.protofile is not commented so tools like grpcui and protoc-gen-doc aren't as helpful as they could be.What was done?
Added ChatGPT-derived comments for all endpoint fields
How Has This Been Tested?
Shouldn't be any functional changes. Just improves experience in grpui (tooltips show info for fields) and protoc-gen-doc (generated docs include more info).
Breaking Changes
None
Checklist:
For repository code-owners and collaborators only