help

package

v13.4.0+incompatible Latest Latest Go to latest Published: Jan 25, 2019 License: Apache-2.0 Imports: 13 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

Package help prints help messages about parts of plz.

This section is empty.

This section is empty.

func Help(topic string) bool

Help prints help on a particular topic. It returns true if the topic is known or false if it isn't.

func Topics(prefix string)

Topics prints the list of help topics beginning with the given prefix.

type Topic string

Topic is a help topic that implements completion for flags. It's otherwise equivalent to a string.

func (topic Topic) Complete(match string) []flags.Completion

Complete implements the flags.Completer interface, which is used for shell completion.

func (topic *Topic) UnmarshalFlag(value string) error

UnmarshalFlag implements the flags.Unmarshaler interface

Path	Synopsis
config Package main implements a parser for our config structure that emits help topics based on its struct tags.	Package main implements a parser for our config structure that emits help topics based on its struct tags.