4 ms·
>> How do you write automated tests for documentation? Somehow require that blocks of code have documentation linked to them? It could be tests to ensure docum
by thesuperbigfrog 2y ago
>> How do you write automated tests for documentation? Somehow require that blocks of code have documentation linked to them?
It could be tests to ensure documentation "builds" into all of the desired formats (e.g. web, pdf, ebooks, etc.) correctly.
Some programming languages have the idea of "documentation tests". In Rust, tests that are part of the documentation will run as part of the documentation build:
https://doc.rust-lang.org/rustdoc/write-documentation/documentation-tests.html https://doc.rust-lang.org/rustdoc/write-documentation/docume...
- Nzen 2y agoIf we treat specifications written in gherkin syntax [0] as documentation, then the cucumber framework can match a line or stanza of gherkin to a test function [1]. I admit that, while I write instructions for how to test specific functionality in gherkin, our company would not countenance publishing a non-narrative description of the system's behavior to our client's employees. [0] https://www.manning.com/books/writing-great-specifications https://www.manning.com/books/writing-great-specifications Given a work order xx and xx isExpedite When an operator prints the jobcard Then expect a label in the footer that says Expedite [1] https://cucumber.io/docs/cucumber/step-definitions/?lang=java https://cucumber.io/docs/cucumber/step-definitions/?lang=jav...