notes

package

v0.0.0-...-310ba95 Latest Latest Go to latest Published: Jun 2, 2019 License: MIT Imports: 10 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.

func AllNotes(target, base string, opts ...Option) (map[string][]Note, error)

AllNotes returns all notes for all packages in a directory

type Note struct {
	Tag  string
	UID  string
	Body string
	Loc  gomate.CodeRef
}

Note is a godoc note found in Go source code comments

func (n Note) String() string

String returns a simple representation of a note

type Option func(*config)

Option allows customizing the note function default behavior

func WithTestdata() Option

WithTestdata will override the default behavior of skipping the testdata folder.

Path	Synopsis
notes notes is a utility that recursively scans all note markings in a directory and returns a representation of those notes mapped by tag and ID to the actual note and location.	notes is a utility that recursively scans all note markings in a directory and returns a representation of those notes mapped by tag and ID to the actual note and location.