DocumentationDiscoveryModule
PackageFsLiveDocs.Core
Canonical discovery of expanded documentation code.
Summary
| Name | Signature | Synopsis |
|---|---|---|
| normalizeSource | normalizeSource source | No description available. |
| scanFsharpFences | scanFsharpFences markdown | Scans Markdown for fsharp fenced code blocks at the top nesting level only. |
| sourceHash | sourceHash mode source | No description available. |
| contextHash | contextHash prelude blocks | Hashes every input that can change the meaning of a block without changing its displayed source. |
| parseMode | parseMode info | Parses and validates a fenced-code info string. |
| discoverMarkdown | discoverMarkdown sourcePath project expandedMarkdown | Discovers blocks from Markdown after shortcode/API expansion has completed. |
| validateCoverage | validateCoverage blocks | Ensures every discovered block has exactly the checking/execution coverage promised by its mode. |
| compilationUnits | compilationUnits projectPath prelude blocks | Builds page-scoped and isolated compiler units without executing ordinary examples. |
| verificationCases | verificationCases projectPath prelude blocks | No description available. |
| generatedCases | generatedCases projectPath prelude sourcePath expandedMarkdown externallyExecutedBlockIds | Produces the stable values embedded in generated tests. |
Scans Markdown for fsharp fenced code blocks at the top nesting level only.
Parameters
| Name | Type | Description |
|---|---|---|
| markdown | string |
Returns
FenceMatch list
Parameters
| Name | Type | Description |
|---|---|---|
| mode | DocumentationBlockMode | |
| source | string |
Returns
string
Hashes every input that can change the meaning of a block without changing its displayed source.
Parameters
| Name | Type | Description |
|---|---|---|
| prelude | string | |
| blocks | DocumentationBlock list |
Returns
string
Parses and validates a fenced-code info string. Contradictions fail before compiler work begins.
Parameters
| Name | Type | Description |
|---|---|---|
| info | string |
Returns
DocumentationBlockMode
Discovers blocks from Markdown after shortcode/API expansion has completed.
Parameters
| Name | Type | Description |
|---|---|---|
| sourcePath | string | |
| project | string option | |
| expandedMarkdown | string |
Returns
DocumentationBlock list
Ensures every discovered block has exactly the checking/execution coverage promised by its mode.
Parameters
| Name | Type | Description |
|---|---|---|
| blocks | DocumentationBlock list |
Returns
unit
Builds page-scoped and isolated compiler units without executing ordinary examples.
Parameters
| Name | Type | Description |
|---|---|---|
| projectPath | string | |
| prelude | string | |
| blocks | DocumentationBlock list |
Returns
CompilationUnit list
Parameters
| Name | Type | Description |
|---|---|---|
| projectPath | string | |
| prelude | string | |
| blocks | DocumentationBlock list |
Returns
VerificationCase list
generatedCases projectPath prelude sourcePath expandedMarkdown externallyExecutedBlockIds
Member
Produces the stable values embedded in generated tests. Validation and case composition
remain owned here so generated callers cannot omit or reorder policy steps.
Parameters
| Name | Type | Description |
|---|---|---|
| projectPath | string | |
| prelude | string | |
| sourcePath | string | |
| expandedMarkdown | string | |
| externallyExecutedBlockIds | Set<string> |
Returns
GeneratedVerificationCase list