doc

Documentation

Overview

Package doc contains helper functions to run doc examples as testscript scripts to keep the docs up to date with the code at the head of the repository.

Index

• func RunOneScript(t *testing.T, dir string, file string)
• func SortedTestScripts(t *testing.T, dir string) (files []string)
• func TestMain(m *testing.M)

Functions

func RunOneScript

func RunOneScript(t *testing.T, dir string, file string)

func SortedTestScripts

func SortedTestScripts(t *testing.T, dir string) (files []string)

SortedTestScripts returns test scripts in sorted order for sequential execution. Scripts are executed in parallel by default with testscript, which is a problem for the docs that build on previous examples.

func TestMain

func TestMain(m *testing.M)