opdocs

Documentation

Overview

Command opdocs generates the operator reference in docs/operators/.

Each operator's entry is assembled from three things that already exist, so the reference cannot drift from the library:

• its signature and doc comment, read from the package source;
• its worked example, read from the Example function in the tests — which `go test` runs and whose output it verifies, so a stale example fails the build rather than misleading a reader;
• its memory and termination markers, read from the ⚠ notes the doc comments already carry.

Examples are matched to operators by the godoc naming convention (`ExampleSeq_Filter` documents `Seq.Filter`), which means the same functions also appear on pkg.go.dev at no extra cost.

Run `go generate ./...`; CI fails if the output is not current.