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

chore: add comments to the platform.proto file #1641

Open
wants to merge 15 commits into
base: v1.0-dev
Choose a base branch
from

Conversation

thephez
Copy link
Collaborator

@thephez thephez commented Dec 13, 2023

Issue being fixed or feature implemented

The platform.proto file 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:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Copy link
Member

@shumkov shumkov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job! Left one comment

packages/dapi-grpc/protos/platform/v0/platform.proto Outdated Show resolved Hide resolved
@thephez
Copy link
Collaborator Author

thephez commented Jan 24, 2024

@shumkov I rebased this so it can be merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants