help

Documentation

Index

• type Examples
  • func (ebce Examples) String() string
• type Help
  • func New(opts ...Option) *Help
  • func (h Help) String() string
• type Option
  • func ArgsOpt(args string) Option
  • func CommandsOpt(commands string) Option
  • func ExamplesOpt(examples string) Option
  • func HeaderOpt(header string) Option
  • func UsageOpt(usage string) Option
• type Summary
  • func (ebcs Summary) String() string
• type Usage
  • func (ebcu Usage) String() string

Types

type Examples

type Examples []string

Examples Evebot Command Examples

func (Examples) String

func (ebce Examples) String() string

String converts example slice to a string

type Help

type Help struct {
	Summary  string
	Usage    string
	Examples string
	Args     string
	Commands string
	Header   string
}

Help data structure

func New

func New(opts ...Option) *Help

New creates a new Help structure

func (Help) String

func (h Help) String() string

String Evebot Command Help

type Option

type Option func(*Help)

Option type for dynamic opts

func ArgsOpt

func ArgsOpt(args string) Option

ArgsOpt is a header option

func CommandsOpt

func CommandsOpt(commands string) Option

CommandsOpt is a header option

func ExamplesOpt

func ExamplesOpt(examples string) Option

ExamplesOpt is a header option

func HeaderOpt

func HeaderOpt(header string) Option

HeaderOpt is a header option

func UsageOpt

func UsageOpt(usage string) Option

UsageOpt is a header option

type Summary

type Summary string

Summary Evebot Command Summary

func (Summary) String

func (ebcs Summary) String() string

String converts the Summary help to a string

type Usage

type Usage []string

Usage Evebot Command Usage

func (Usage) String

func (ebcu Usage) String() string

String converts the User string slice to a string