Repository navigation
Exposure of Literate as doc test utility #1221
Description
For years, I was under the impression that fsharp simply has no tool for doc tests.
Arguably is XMLDoc capabable to be used as such, while the term 'doc test' is really not associated by SEO with F# tools, when you look for it.
I think Literate could get its own repo, with appropriate documentation regarding its capabilities, meaning we include the term doc test library and also add it to the awesome lists.
I can also see a mention in the weekly newsletter as appropriately.
In any case, is a more popular exposure of it for this use case suggested, and I invite the maintainers of this package and FSharp.Formatting at large to comment, of course.
Thanks ☀️
Activity
github-actions commentedon Jul 29, 2026
🤖 This is an automated response from Repo Assist.
Great suggestion! FSharp.Formatting's
Literatelibrary can definitely be used for doc testing — it executes F# code snippets and can verify their output, making it useful for keeping documentation examples correct.A few thoughts on increasing visibility:
Whether a standalone package/repo makes sense is a maintainer decision — splitting it would mean more maintenance overhead, but could increase visibility. Either way, improving the documentation of this use case within the existing repo seems like a good low-effort starting point.
Add this agentic workflow to your repo
To install this agentic workflow, run
ShalokShalom commentedon Aug 5, 2026
I thought more about actually describing this functionality in the repos main README.
docs: describe Literate scripts as a lightweight doc-testing mechanism
[repo-assist] docs: describe Literate scripts as a lightweight doc-te…
ShalokShalom commentedon Nov 4, 2026
In case someone else is looking for a solution for fsharp, here is another tool, that I found:
https://mangelmaxime.github.io/Nacara/