diff options
| author | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-05-09 13:43:24 +0300 |
|---|---|---|
| committer | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-05-09 16:13:30 +0300 |
| commit | 670560f0b21846181f1d78de685116dde86a72e5 (patch) | |
| tree | f9911888deac02b2adc7a910e671522edbe854d3 | |
| parent | a5668263ba60ec8a7bec5e334295b4286f977bd5 (diff) | |
protolint: Clarify comment why we don't want to enforce file comments
The excluded `FILE_HAS_COMMENT` has an out-of-date explanation that
still extends to all the other comment-linting-rules we had disabled.
Update the comment to only explain why we don't enforce file comments.
| -rw-r--r-- | proto/.protolint.yaml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/proto/.protolint.yaml b/proto/.protolint.yaml index a578b1131..1a53539c0 100644 --- a/proto/.protolint.yaml +++ b/proto/.protolint.yaml @@ -5,9 +5,9 @@ lint: remove: # We don't specify any line length limits. - MAX_LINE_LENGTH - # Many of our definitions aren't commented at all. We want to eventually - # opt-in to enable these linting warnings, but right now we just want to - # get protolint included in our workflow with minimal required changes. + # We do not put comments in front of files. We already document services, + # and only have a single service per file, so there is not much of a + # point anyway. - FILE_HAS_COMMENT # Many of our fields and messages have prepositions in them, and # furthermore this rule doesn't feel all that sensible after all. We thus |