help

package

v12.2.0+incompatible Latest Latest Go to latest Published: May 3, 2018 License: Apache-2.0 Imports: 10 Imported by: 0

Details

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.