~samwhited/checkdoc

Check Go packages for documentation.
checkdoc: fix panic when file has no comments
checkdoc: skip checking files in cache
checkdoc: add check for file header comments

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~samwhited/checkdoc
read/write
git@git.sr.ht:~samwhited/checkdoc

You can also use your local clone with git send-email.

#checkdoc

GoDoc Build Status

The checkdoc command scans Go packages for comment and documentation related lints. Currently the tool checks for:

  • Packages that are missing documentation comments
  • Malformed or missing canonical import comments
  • Missing file header comments

#License

The package may be used under the terms of the BSD 2-Clause License a copy of which may be found in the file "LICENSE".