On code samples that drift

Fri, 31 Jan 2025 23:35:09 +0530

The code sample in your README is wrong. Not catastrophically — just enough to make the next person reading it run go build, get an error, and wonder if the problem is them.

I’ve been bitten by this enough times to build a tool around it. But the tool isn’t the interesting part. The interesting part is how this happens, and what it says about the shape of your documentation.

Go on Aman Verma

On code samples that drift