help

Documentation

Overview

Package help exports a function with default help for the core Goal language.

Index

• func HelpFunc() func(string) string
• func Wrap(fs ...func(string) string) func(string) string

Functions

func HelpFunc

func HelpFunc() func(string) string

HelpFunc returns a mapping from topics to help content for use in cmd.Config. It can be wrapped by extensions to provide additional entries or return alternative content for existing ones.

It includes entries for the core language and the default os package extension.

func Wrap

func Wrap(fs ...func(string) string) func(string) string

Wrap produces a help function suitable for use in cmd.Config by combining one or more help functions. For a given topic, the new combined help function tries each help function in order and returns the first non-empty result.