help

package
v13.2.5+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2018 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package help prints help messages about parts of plz.

Index

Constants

This section is empty.

Variables

This section is empty.

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

Directories

Path Synopsis
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.

Jump to

Keyboard shortcuts

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