← Back to context

Comment by wiseowise

4 hours ago

Python community figured this out in 2001: https://docs.python.org/3/library/doctest.html

I don't think this is related in any way.

  • > Having a CI job that identifies places where the docs have drifted from the implementation seems pretty valuable.

    https://docs.python.org/3/library/doctest.html

    > To check that a module’s docstrings are up-to-date by verifying that all interactive examples still work as documented. To perform regression testing by verifying that interactive examples from a test file or a test object work as expected. To write tutorial documentation for a package, liberally illustrated with input-output examples. Depending on whether the examples or the expository text are emphasized, this has the flavor of “literate testing” or “executable documentation”.

    Seems pretty related to me.