The highest tagged major version is v2.

docstring

package

v0.0.0-...-9ff31c3 Latest Latest Go to latest Published: Sep 1, 2021 License: Apache-2.0 Imports: 2 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 Docstring struct {
	Arguments []Argument `(@@|`
	// contains filtered or unexported fields
}

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

func Parse(s string) Docstring

Parse returns the AST of the given doc string.

func (d *Docstring) Identifiers(name string) (identifiers []Identifier)

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

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

func (i *Identifier) NameAsCamelCase() string

NameAsCamelCase returns the identifier's name as camel case. TODO(celicoo): improve this.