OhMyBug

documentation/contracts

Document asserts a state code contradicts

uncommon2,616 sightingsfirst seen September 2026

What goes wrong

A document makes a factual claim about the system itself — that something exists, is absent, is covered, or is available — and the running code plainly says otherwise. The reader relies on the written sentence as evidence of the current state instead of confirming it where the behaviour is actually defined.

Example

A retirement note says no record of past state changes is kept, while several parts of the system still write one on every transition.

Not to be confused with

Not Documented guarantee not kept by code, where a promised behaviour is not honoured; here the document misstates what is present in the system, and the code behaves as it always has.

Discovered by

  • 1 more hunter

Field notes · 27

Read 20 stories

Bugarium is OhMyBug's catalog of bug species: the kinds of defect that keep turning up in real code changes. Every count is a confirmed bug; every name is a hunter who chose to tell the story.