help

Documentation

Overview

Package help prints help messages about parts of plz.

Index

• func Help(topic string) bool
• func Topics(prefix string)
• type Topic
  • func (topic Topic) Complete(match string) []flags.Completion
  • func (topic *Topic) UnmarshalFlag(value string) error

Functions

func Help

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

func Topics(prefix string)

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

Types

type Topic

type Topic string

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

func (Topic) Complete

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

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

func (*Topic) UnmarshalFlag

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

UnmarshalFlag implements the flags.Unmarshaler interface