Skip to content

docs(syntax): fix stale/false claims in SYNTAX.md#442

Merged
InauguralPhysicist merged 1 commit into
mainfrom
docs/syntax-stale-claims
Jul 5, 2026
Merged

docs(syntax): fix stale/false claims in SYNTAX.md#442
InauguralPhysicist merged 1 commit into
mainfrom
docs/syntax-stale-claims

Conversation

@InauguralPhysicist

Copy link
Copy Markdown
Collaborator

A document review found four SYNTAX.md claims contradicted by the running binary:

  • "No break/continue" — both keywords exist and work.
  • "n is still available for backward compatibility" (with named params) — false: define f(a) as: return n raises undefined variable 'n'.
  • "list/dict literals must be single-line" (stated twice) — false, multiline works.
  • REPL banner "0.6.0" → 0.26.0.

The (entirely false) "Limitations" section is replaced with a "Gotchas" section covering the real ones (the f of [x] spread trap, byte-strings, finite numbers). Not in the byte-checked doc set.

🤖 Generated with Claude Code

A document review found four claims contradicted by the running binary:
- "No break/continue: use flag variables" — both keywords are real and work
  (`break` in a loop exits it).
- "`n` is still available ... for backward compatibility" (with a named param
  list) — false: `define f(a) as: return n` raises `undefined variable 'n'`.
  The implicit `n` exists only when there is NO parameter list.
- "list/dict literals must be on a single line" (twice) — false: multiline
  collections inside `[ ]`/`{ }` parse fine.
- REPL banner shown as "EigenScript 0.6.0" — now 0.26.0.

Replaced the (entirely false) "Limitations" section with a "Gotchas" section
covering the REAL ones: the `f of [x]` spread trap, byte-strings-not-chars, and
finite numbers. SYNTAX.md is not in the byte-checked doc-examples set.
@InauguralPhysicist InauguralPhysicist merged commit b77b048 into main Jul 5, 2026
16 of 17 checks passed
@InauguralPhysicist InauguralPhysicist deleted the docs/syntax-stale-claims branch July 5, 2026 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant