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 for proper godoc-style comments #485

Merged
merged 2 commits into from
Mar 24, 2021

Conversation

rfratto
Copy link
Member

@rfratto rfratto commented Mar 24, 2021

PR Description

Disables default exclusions from the golint-ci config, which used to ignore a lack of godoc-style comments on exported types and methods. This caused a lot of errors, so I added comments from anything that was missing them.

Which issue(s) this PR fixes

Notes to the Reviewer

Fully an internal change, and only comments have been updated.

PR Checklist

  • CHANGELOG updated
  • Documentation added
  • Tests updated

@rfratto rfratto requested a review from mattdurham March 24, 2021 16:43
Copy link
Collaborator

@mattdurham mattdurham left a comment

Choose a reason for hiding this comment

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

Looks good

@rfratto rfratto merged commit 5c1b14b into grafana:main Mar 24, 2021
@rfratto rfratto deleted the lint-for-godoc-comments branch March 24, 2021 17:11
@mattdurham mattdurham mentioned this pull request Sep 7, 2021
3 tasks
mattdurham pushed a commit that referenced this pull request Nov 11, 2021
* lint for proper godoc-style comments

* fix Linux-specific lint error
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Apr 15, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants