example

package

v1.0.1 Latest Latest Go to latest Published: Jan 10, 2024 License: LGPL-3.0 Imports: 11 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

Repository

github.com/bengarrett/retrotxtgo

Links

Open Source Insights

Documentation ¶

Overview ¶

Package example provides help usage examples for the cmd package.

Constants ¶

View Source

const Filenames = "[filenames]"

Filenames is the placeholder for the filenames in the help usage examples.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Example ¶

type Example int

Example is the type for the help usage examples.

const (
	Cmd      Example = iota // Cmd is the example for the root command.
	Examples                // Examples are the examples for the list examples command.
	Table                   // Table are the examples for the list tables command.
	Info                    // Info is the example for the info command.
	View                    // View is the example for the view command.
	Dump                    // Dump is the example for the dump command.
)

func (Example) String ¶

func (e Example) String(w io.Writer)

Example string writes the example usage help.

Source Files ¶

View all Source files

example.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL