News for hackers. Stuff that matters.
Re:Docs as code (2017) by simonw on Tuesday July 09, 2024 @12:54PM (#40918244)
I wrote about my way of doing that here: https://simonwillison.net/2018/Jul/28/documentation-unit-tes...

Short version: have tests that use introspection (listing functions and classes in a module, iterating over JSON API endpoints in the codebase etc) and then run regular expressions against your documentation searching for relevant headings or other pre-determined structures.

There are no comments on this comment yet.