search

opiproject / opi-api

Open Programmable Infrastructure API and Behavioral Model
Apache License 2.0
31 stars 40 forks source link

docs(storage): add proto comments #346

Closed glimchb closed 1 year ago

glimchb commented 1 year ago 
+--------------------------+------------------+----------------+
|           RULE           | TOTAL VIOLATIONS | VIOLATED FILES |
+--------------------------+------------------+----------------+
| core::0192::has-comments |              409 |              9 |
+--------------------------+------------------+----------------+

and now

+--------------------------+------------------+----------------+
|           RULE           | TOTAL VIOLATIONS | VIOLATED FILES |
+--------------------------+------------------+----------------+
| core::0192::has-comments |              272 |              9 |
+--------------------------+------------------+----------------+
glimchb commented 1 year ago

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.... )))