Model-Drafted Documentation Examples Must Be Executed or Labeled, Only Humans Assert Output
A documentation approach holds that every fenced code block must either be executed by CI or explicitly marked as illustrative with a named owner. Models may propose code examples, but only a human may state what that code prints, which prevents confident examples that were never run. The author argues the constraint is intentionally narrow and targets a specific defect in model-drafted docs. The reasoning rests on the asymmetry between prose, where errors cost readers a minute, and commands, where errors can waste hours of debugging. The convention is encoded in a fence info-string label, with a small Python gate that runs runnable blocks in fresh temporary directories.
This is an AI-generated summary. ShortSingh links to the original source for the complete article.

Discussion (0)
Log in to join the discussion and vote.
Log in