doc

Documentation

Overview

Package doc provides the constant can be used in example test files. Most of the example tests in this repo are fail to run on the GoDoc website because of the missing variables. In order to avoid confusing users, these tests should be unplayable on the GoDoc website, and this can be achieved by leveraging a dot import in the test files. Reference: https://pkg.go.dev/go/doc#Example

Index

• Constants

Constants

const ExampleUnplayable = true

ExampleUnplayable is used in examples test files in order to make example tests unplayable.