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

docs(storage): add proto comments #346

Merged
merged 2 commits into from
Aug 31, 2023
Merged

docs(storage): add proto comments #346

merged 2 commits into from
Aug 31, 2023

Conversation

glimchb
Copy link
Member

@glimchb glimchb commented Aug 31, 2023

  • docs(storage): add proto comments
  • chore(storage): auto-generated protos
+--------------------------+------------------+----------------+
|           RULE           | TOTAL VIOLATIONS | VIOLATED FILES |
+--------------------------+------------------+----------------+
| core::0192::has-comments |              409 |              9 |
+--------------------------+------------------+----------------+

and now

+--------------------------+------------------+----------------+
|           RULE           | TOTAL VIOLATIONS | VIOLATED FILES |
+--------------------------+------------------+----------------+
| core::0192::has-comments |              272 |              9 |
+--------------------------+------------------+----------------+

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>
Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>
@glimchb glimchb marked this pull request as ready for review August 31, 2023 12:05
@glimchb glimchb requested a review from a team as a code owner August 31, 2023 12:05
Copy link
Contributor

@artek-koltun artek-koltun left a comment

Choose a reason for hiding this comment

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

I am wondering why many comments for messages (e.g. Update*Request, List*Request), enums (e.g. enum NvmeMultipath) and fields(e.g. parent, page_size) are missed? AIP-192 says that

... public comments must be included over every component (service, method, message, field, enum, and enum value) ...

opicommon.proto file is also missed

@glimchb
Copy link
Member Author

glimchb commented Aug 31, 2023

I am wondering why many comments for messages (e.g. Update*Request, List*Request), enums (e.g. enum NvmeMultipath) and fields(e.g. parent, page_size) are missed? AIP-192 says that

... public comments must be included over every component (service, method, message, field, enum, and enum value) ...

opicommon.proto file is also missed

just tired writing comments... and decided to pause and commit... will pick up and do leftovers once have a bit more time.... )))

@glimchb glimchb merged commit 1362711 into opiproject:main Aug 31, 2023
7 checks passed
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