examples

Documentation

Index

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

Types

type Examples

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

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

func NewExamples

func NewExamples() *Examples

NewExamples creates a new Examples object.

type Parser

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

Parser is a Parser implementation for parsing examples.

func New

func New() *Parser

New creates a new Package.

func (*Parser) Parse

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

Parse is the underlying logic for parsing examples.