pawamoy / pawamoy/markdown-exec
feature: docs as tests - validate computed output against the output in the codeblock
Open
@pawamoy is already working on this.
Since Feb 4, 2025.
feature
insiders
- Dominant language
- Python
- Stars
- 174
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Description
Problem
I want to know if I've introduced a bug in my project that broke my documentation.
Describe the solution you'd like
There could be two parts to this.
- make
pyconwork more like docstring tests, and error if the computed output doesn't match the output shown in the markdown- Ideally this solution would be easy to replicate for typescript/javascript once #70 merges
- add an option that makes other codeblocks work more like traditional replay tests by capturing the output to files somewhere, and then on recompute, checking the recomputed outputs against those files
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.