Examples in documentation should be compiled and run as tests, so that changing the code breaks the docs instead of quietly outdating them.

Added to korrents 20 May 2026 · How quotes work · Something wrong? Tell us

Related korrents

Our reading — they may agree, disagree or merely touch the same thing. Closest first: a shared subject counts for most, then how near the wording is.

• A design proposal should describe the feature as though it already existed — once as a tutorial and once as reference documentation. ARAlice Ryhl20 May 2026documentation
• Do not run a personal agent on a cheap or local model: weak models are gullible and easy to prompt-inject. PSPeter Steinberger12 Feb 2026documentation
• Good documentation is produced by effort, not by tooling that keeps code and docs together HHHamel Husain18 Jan 2026documentation
• If you will write a huge markdown file so an agent has context, you should have written the documentation that gives a human the same context. KHKelsey Hightower3 Jun 2026documentation
• Standardised manufacturing and documentation cannot be skipped when a drug is given to human beings, because the noise they remove is the noise that would otherwise swallow the answer. DLDerek Lowe1 May 2020documentation

See this on the map →