馃尡 Enforce godoc comments for exported functions #5817
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/S
sbueringer
reviewed
Dec 8, 2021
test/infrastructure/docker/exp/api/v1alpha3/dockermachinepool_types.go
Outdated
Show resolved
Hide resolved
test/infrastructure/docker/exp/api/v1alpha4/dockermachinepool_types.go
Outdated
Show resolved
Hide resolved
test/infrastructure/docker/exp/api/v1beta1/dockermachinepool_types.go
Outdated
Show resolved
Hide resolved
This updates a filter in our golangci-lint configuration to start enforcing the presence of godoc comments on any functions or variables that are exported. This aligns with most of the rest of the codebase and makes it so there is (somewhat) useful documentation for anything that can be accessed externally from a package. Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
stmcginnis
force-pushed
the
exportedmethod
branch
from
8a79c79
to
a0890c8
Compare
k8s-ci-robot
added
size/M
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: fabriziopandini The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
Thanks for improving or code quality! |
|
Absolutely agree! Thx a lot. Things like this are minor issues, but they raise the quality overall and the linter will help us to keep it there :) /lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This updates a filter in our golangci-lint configuration to start
enforcing the presence of godoc comments on any functions or variables
that are exported in the
infrastructure/dockerpath.This aligns with most of the rest of the codebase and
makes it so there is (somewhat) useful documentation for anything that
can be accessed externally from a package.