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

Ignore lint errors about package comments #5178

Merged
merged 5 commits into from Feb 28, 2024
Merged

Conversation

pdabelf5
Copy link
Collaborator

@pdabelf5 pdabelf5 commented Feb 28, 2024

Proposed changes

The majority of the packages created in the project do not have comments, they are also not exported as external modules so do not generate godocs. Removing the package comments lint module.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@pdabelf5 pdabelf5 requested a review from a team as a code owner February 28, 2024 10:38
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Feb 28, 2024
@github-actions github-actions bot removed the documentation Pull requests/issues for documentation label Feb 28, 2024
@pdabelf5 pdabelf5 merged commit 51ee5b7 into main Feb 28, 2024
78 checks passed
@pdabelf5 pdabelf5 deleted the lint-package-comments branch February 28, 2024 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

None yet

3 participants