Documentation
¶
Overview ¶
Package cmdhelp is a nushell command's help, F1 on a command in a notebook's cell: a scrollable box over the notebook with what the command does, a link to its page in nushell's docs, its usage, flags, parameters, input and output types and examples, as nu's help has them. It knows the UI only through Host.
Index ¶
Constants ¶
View Source
const ID = "cmdhelp"
ID identifies the view's box in mouse events.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Host ¶
type Host interface {
Theme() *theme.Theme
Size() (width, height int)
// Close closes the open overlay.
Close()
// Code draws a line of nushell highlighted.
Code(src string) string
}
Host is what the help needs of the UI.
Source Files
Click to show internal directories.
Click to hide internal directories.