The highest tagged major version is v2.

text

package

v1.0.0 Latest Latest Go to latest Published: Mar 11, 2019 License: MIT Imports: 1 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.

This section is empty.

type Argument struct {
	Indentation string       `@('\n' (' '|'\t')+)`
	Identifiers []Identifier `@@+`
}

type Identifier struct {
	Name      string `@('-'|Let|Num)+`
	Separator string `@(',' ' ')?`
}

type Text struct {
	Arguments []Argument `(@@|`
	// contains filtered or unexported fields
}

Text is both used as the grammar and the tree representation of the abstract syntactic structure of a doc string.

func Parse(doc string) (Text, error)

Parse returns the AST of the given text.

func (t *Text) Identifiers(name string) (identifiers []string)

Identifiers returns all identifiers of an argument if any of them match the given value.

func (t *Text) IsValidIdentifier(name string) bool

IsValidIdentifier returns true if the given value is a valid identifier of an argument or false otherwise.