examples

package

v0.4.1-0...-1fefb53 Latest Latest Go to latest Published: Apr 8, 2024 License: Apache-2.0 Imports: 3 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.

This section is empty.

func FormatExamples(examples ...Example) string

FormatExamples formats one or more Example instances.

type Example struct {
	Descriptions  []string
	RootCommand   string
	CommandString string
}

Example defines fields required to construct a CLI command example

func (e *Example) String() string

String renders a formatted example.