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

lint: enable export documentation check #963

Open
MSevey opened this issue Nov 4, 2022 · 2 comments
Open

lint: enable export documentation check #963

MSevey opened this issue Nov 4, 2022 · 2 comments
Labels
CI item that directly relates to or modify the CI documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@MSevey
Copy link
Member

MSevey commented Nov 4, 2022

With the revive linter replacing golint within golangci-lint, the check for exports having documentation has been disabled by default.

This should be re-enabled as all exports should have documentation and reviews are having to check for this unnecessarily.

linters:
  enable:
    - revive

linters-settings:
  revive:
    rules:
      - name: exported
        arguments:
          - disableStutteringCheck

issues:
  include:
    - EXC0012  # EXC0012 revive: Annoying issue about not having a comment. The rare codebase has such comments
    - EXC0014  # EXC0014 revive: Annoying issue about not having a comment. The rare codebase has such comments

See https://www.pixelstech.net/article/1650069870-golangci-lint-to-enable-comment-check-for-exported-functions

@MSevey MSevey self-assigned this Nov 4, 2022
@evan-forbes evan-forbes added good first issue Good for newcomers CI item that directly relates to or modify the CI labels Jan 31, 2023
@evan-forbes
Copy link
Member

blocked by #1321

@evan-forbes evan-forbes added this to the Mainnet milestone Jan 31, 2023
@MSevey
Copy link
Member Author

MSevey commented Feb 2, 2023

blocked by #1321

or...enables #1321 haha
probably should be done together since it would validate that we hit them all.

@rootulp rootulp added the documentation Improvements or additions to documentation label Feb 3, 2023
@evan-forbes evan-forbes removed this from the Mainnet milestone Apr 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI item that directly relates to or modify the CI documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants