Skip to content

docs: fix the four front-door examples that misrepresented the language#476

Merged
InauguralPhysicist merged 1 commit into
mainfrom
docs/front-door-example-fixes
Jul 8, 2026
Merged

docs: fix the four front-door examples that misrepresented the language#476
InauguralPhysicist merged 1 commit into
mainfrom
docs/front-door-example-fixes

Conversation

@InauguralPhysicist

Copy link
Copy Markdown
Collaborator

The first artifacts a stranger reads — the README and the intro docs — were wrong on the exact surfaces we lead with. Every corrected example was verified against the real runtime.

What was broken

Verification

All corrected examples run byte-true against the current runtime:

Docs-only; tools/doc_drift_check.sh passes.

Closes #313
Closes #319
Closes #320
Closes #318

🤖 Generated with Claude Code

The README and doc examples a newcomer reads first were wrong on the
exact surfaces we lead with. Verified every corrected example against
the real runtime (byte-true output shown):

- README observer example (#313): `5,2,5,2` classified as `diverging`,
  not the claimed `oscillating` — four samples is too short. Extended to
  three periods (`5,2,5,2,5,2`) so it truly prints `oscillating`. This
  is the showcase of the observer, our whole differentiator; it printed
  the wrong trajectory.
- README stdlib snippet (#319): `map of [[1,2,3], double]` referenced an
  undefined `double` and crashed with `undefined variable 'double'` on a
  reader's first copy-paste. Now defines `double` inline; prints [2,4,6].
- lib/format.eigs fmt_bar docstring (#320): showed `████░░░░░░`; actual
  output is `[######....] 60.0%`. Docstring now matches the runtime.
- String-escape docs (#318): SYNTAX/GRAMMAR/LANGUAGE_CONTRACT implied a
  closed escape set `\n \t \r \\ \" \{ \}`. The lexer recognizes
  `\n \t \r \\ \"` and drops the backslash on any other `\x` (so `\{`/`\}`
  give literal braces via the catch-all, and `\r` was real but only
  documented in the contract). Docs now state the true contract.

Docs-only; doc_drift_check.sh passes.

Closes #313
Closes #319
Closes #320
Closes #318

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@InauguralPhysicist InauguralPhysicist merged commit 4d8ebb4 into main Jul 8, 2026
17 checks passed
@InauguralPhysicist InauguralPhysicist deleted the docs/front-door-example-fixes branch July 8, 2026 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment