mellium
/
checkdoc
7
0
Fork 0
Code Issues Pull Requests Releases Activity
The checkdoc command scans Go packages for comment and documentation related issues. https://mellium.im/checkdoc/
16 Commits
2 Branches
1 Tag
57 KiB
Go 100%
 
Go to file
Sam Whited 3811736603
ci/woodpecker/push/dco Pipeline was successful Details
ci/woodpecker/push/validate Pipeline failed Details
ci/woodpecker/push/test Pipeline was successful Details
ci/woodpecker/tag/dco Pipeline was successful Details
ci/woodpecker/tag/test Pipeline was successful Details
ci/woodpecker/tag/validate Pipeline failed Details
all: bump Go version and deps 
This fixes an error in older versions of golang.org/x/tools where
sometimes packages would fail to load.

See https://golang.org/issues/37617

Signed-off-by: Sam Whited <sam@samwhited.com>
 		2022-12-31 09:40:06 -05:00
.woodpecker all: use Codeberg CI (Woodpecker) 2022-07-15 06:47:28 -04:00
.gitignore checkdoc: new tool to check for package level docs 2019-09-06 12:46:56 -05:00
LICENSE checkdoc: new tool to check for package level docs 2019-09-06 12:46:56 -05:00
README.md all: use Codeberg CI (Woodpecker) 2022-07-15 06:47:28 -04:00
analyzer.go all: use Codeberg CI (Woodpecker) 2022-07-15 06:47:28 -04:00
go.mod all: bump Go version and deps 2022-12-31 09:40:06 -05:00
go.sum all: bump Go version and deps 2022-12-31 09:40:06 -05:00
header.go all: use Codeberg CI (Woodpecker) 2022-07-15 06:47:28 -04:00
main.go all: use Codeberg CI (Woodpecker) 2022-07-15 06:47:28 -04:00
tools.go all: use Codeberg CI (Woodpecker) 2022-07-15 06:47:28 -04:00

README.md

checkdoc

Issue Tracker Docs Chat License

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

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

If you'd like to contribute to the project, see CONTRIBUTING.md.

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".