16
Towards Understandable Software
(gracefulliberty.com)
Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!
Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.
Hope you enjoy the instance!
Rules
Follow the wormhole through a path of communities !webdev@programming.dev
The best built-in implementation for this that I've seen is Rust's doctests. You write a block of code in your documentation. Then you run
cargo test. The code gets compiled and executed as part of your tests, and panics get reported as failures. You can also mark code blocks asshould_panic,compile_fail,ignore, etc if needed.I'd love to see tools like this in other languages. Write the docs next to the code, but compile the docs as well and make sure they actually work. This is sort of what Entangled seems to do, but ideally more entangled with the build process.