DocTestRunnerModule
PackageFsLiveDocs.Runner
DocTestRunner
DocTestRunner supports named XML documentation snapshots.
Use snapshotExampleNames to enumerate explicitly selected examples. Use collectSnapshotByName to execute one example and return its owned snapshot result.
Generated Markdown verification does not call DocTestRunner directly. It uses stable GeneratedVerificationCase values and GeneratedVerification.runCase.
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Operations | ||
| snapshotExampleNames | snapshotExampleNames package | Returns stable names for all explicitly selected XML examples. |
| collectSnapshotByName | collectSnapshotByName package projectPath references name | Runs one named XML example so generated test discovery identifies it directly. |
| collectSnapshots | collectSnapshots package projectPath references | Runs snapshot-selected examples and returns structured results for a generated Verify project. |
Operations
kind:member
kind:member
kind:member
Runs snapshot-selected examples and returns structured results for a generated Verify project.
Parameters
| Name | Type | Description |
|---|---|---|
| package | PackageModel | The package model containing examples and scenarios. |
| projectPath | string | The project that produced the package. |
| references | string list | Additional references needed by generated examples. |
Returns
Async<ProjectSnapshotModel>