DocumentationDiscoveryModule

PackageFsLiveDocs.Core
Canonical discovery of expanded documentation code.

Summary

NameSignatureSynopsis
Operations
normalizeSourcenormalizeSource sourceNo description available.
scanFsharpFencesscanFsharpFences markdownScans Markdown for fsharp fenced code blocks at the top nesting level only.
sourceHashsourceHash mode sourceNo description available.
contextHashcontextHash prelude blocksHashes every input that can change the meaning of a block without changing its displayed source.
parseModeparseMode infoParses and validates a fenced-code info string.
discoverMarkdowndiscoverMarkdown sourcePath project expandedMarkdownDiscovers blocks from Markdown after shortcode/API expansion has completed.
validateCoveragevalidateCoverage blocksEnsures every discovered block has exactly the checking/execution coverage promised by its mode.
compilationUnitscompilationUnits projectPath prelude blocksBuilds page-scoped and isolated compiler units without executing ordinary examples.
verificationCasesverificationCases projectPath prelude blocksNo description available.
generatedCasesgeneratedCases projectPath prelude sourcePath expandedMarkdown externallyExecutedBlockIdsProduces the stable values embedded in generated tests.

Operations

kind:member

normalizeSource

normalizeSource source
Member

Parameters

NameTypeDescription
sourcestring

Returns

string
kind:member

scanFsharpFences

scanFsharpFences markdown
Member
Scans Markdown for fsharp fenced code blocks at the top nesting level only.

Parameters

NameTypeDescription
markdownstring

Returns

FenceMatch list
kind:member

sourceHash

sourceHash mode source
Member

Parameters

NameTypeDescription
modeDocumentationBlockMode
sourcestring

Returns

string
kind:member

contextHash

contextHash prelude blocks
Member
Hashes every input that can change the meaning of a block without changing its displayed source.

Parameters

NameTypeDescription
preludestring
blocksDocumentationBlock list

Returns

string
kind:member

parseMode

parseMode info
Member
Parses and validates a fenced-code info string. Contradictions fail before compiler work begins.

Parameters

NameTypeDescription
infostring

Returns

DocumentationBlockMode
kind:member

discoverMarkdown

discoverMarkdown sourcePath project expandedMarkdown
Member
Discovers blocks from Markdown after shortcode/API expansion has completed.

Parameters

NameTypeDescription
sourcePathstring
projectstring option
expandedMarkdownstring

Returns

DocumentationBlock list
kind:member

validateCoverage

validateCoverage blocks
Member
Ensures every discovered block has exactly the checking/execution coverage promised by its mode.

Parameters

NameTypeDescription
blocksDocumentationBlock list

Returns

unit
kind:member

compilationUnits

compilationUnits projectPath prelude blocks
Member
Builds page-scoped and isolated compiler units without executing ordinary examples.

Parameters

NameTypeDescription
projectPathstring
preludestring
blocksDocumentationBlock list

Returns

CompilationUnit list
kind:member

verificationCases

verificationCases projectPath prelude blocks
Member

Parameters

NameTypeDescription
projectPathstring
preludestring
blocksDocumentationBlock list

Returns

VerificationCase list
kind:member

generatedCases

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

NameTypeDescription
projectPathstring
preludestring
sourcePathstring
expandedMarkdownstring
externallyExecutedBlockIdsSet<string>

Returns

GeneratedVerificationCase list