examples

package

v1.15.2 Latest Latest Go to latest Published: Apr 9, 2024 License: Apache-2.0 Imports: 7 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

Package examples contains utilities for parsing examples.

This section is empty.

This section is empty.

This section is empty.

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

Examples is the set of metadata and objects in a package.

func NewExamples() *Examples

NewExamples creates a new Examples object.

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

Parser is a Parser implementation for parsing examples.

func New() *Parser

New creates a new Package.

func (p *Parser) Parse(ctx context.Context, reader io.ReadCloser) (*Examples, error)

Parse is the underlying logic for parsing examples.