help

package
Version: v0.23.0 Latest Latest
Warning

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

Go to latest
Published: Oct 21, 2020 License: MPL-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package help - internal help handling code.

Index

Constants

This section is empty.

Variables

View Source
var Indentation = 4

Indentation - Number of spaces used for indentation.

Functions

func CommandList

func CommandList(commandMap map[string]string) string

CommandList - commandMap => name: description

func Name

func Name(scriptName, name, description string) string

Name -

func OptionList

func OptionList(options []*option.Option) string

OptionList - Return a formatted list of options and their descriptions.

func Synopsis

func Synopsis(scriptName, name, args string, options []*option.Option, commands []string) string

Synopsis - Return a default synopsis.

Types

This section is empty.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL