hintsummary

package

v0.0.0-...-e081c89 Latest Latest Go to latest Published: Feb 17, 2024 License: GPL-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	// Summary is an overriding summary for readline hints
	Summary = New()
)

func Get(cmd string, checkManPage bool) (r []rune)

type HintSummary struct {
	// contains filtered or unexported fields
}

HintSummary is a thread-safe map for storing the hint summary overrides

func New() *HintSummary

New creates a new instance of the hint summary override structure

func (hs *HintSummary) Delete(exe string) error

Delete removes a hint summary for a specific executable

func (hs *HintSummary) Dump() map[string]string

Dump returns a JSON-able structure of the stored hint summary overrides

func (hs *HintSummary) Get(exe string) string

Get returns the hint summary override

func (hs *HintSummary) Set(exe, summary string)

Set stores the hint summary override for a specific executable