re-enable golangci-lint's godoc comment checking

[DirectXMan12]

golangci-lint disables the godoc comment checking because the author considers it annoying. We should make sure it's on, because we've got a couple of issues with our godocs.

[DirectXMan12]

#477 has the fix in the first commit

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[DirectXMan12]

/lifecycle frozen

[vincepri]

/priority backlog

[kensipe]

@DirectXMan12 @vincepri I think this is resolved. #773 updated linters... included with that is golint which enables godoc checking.

#773 just merged!

[vincepri]

I don't think golint is enough to have godoc comments. It appears that golangci-lint has default exclusions. To re-enable godoc errors we'll need to add:

issues:
  exclude-use-default: false
  exclude:
    # errcheck: Almost all programs ignore errors on these functions and in most cases it's ok
    - Error return value of .((os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*printf?|os\.(Un)?Setenv). is not checked
    # golint: False positive when tests are defined in package 'test'
    - func name will be used as test\.Test.* by other packages, and that stutters; consider calling this
    # govet: Common false positives
    - (possible misuse of unsafe.Pointer|should have signature)
    # staticcheck: Developers tend to write in C-style with an explicit 'break' in a 'switch', so it's ok to ignore
    - ineffective break statement. Did you mean to break out of the outer loop
    # gosec: Too many false-positives on 'unsafe' usage
    - Use of unsafe calls should be audited
    # gosec: Too many false-positives for parametrized shell calls
    - Subprocess launch(ed with variable|ing should be audited)
    # gosec: Duplicated errcheck checks
    - G104
    # gosec: Too many issues in popular repos
    - (Expect directory permissions to be 0750 or less|Expect file permissions to be 0600 or less)
    # gosec: False positive is triggered by 'src, err := ioutil.ReadFile(filename)'
    - Potential file inclusion via variable

to .golangci.yml

[kensipe]

perhaps I misunderstood based on my reading of golangci/golangci-lint#456

I'll look into it

[DirectXMan12]

My experience is that you have to do what @vincepri mentioned as well. Should be easy to check though :-)

[camilamacedo86]

/assign @camilamacedo86