Deprecated: This has been deprecated in favor of `checkfile`. Please use `checkfile` with argument `--file-name README.md` instead.

checkdoc

command module

v0.4.0 Latest Latest Go to latest Published: Jan 6, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/open-telemetry/opentelemetry-go-build-tools

Links

Open Source Insights

README ¶

Documentation checker

Tool that checks the components enabled in OpenTelemetry core and contrib repos have the proper documentations.

Usage:

checkdoc --project-path path/to/project \
         --component-rel-path service/defaultcomponents/defaults.go \
         --module-name go.opentelemetry.io/collector

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL