Skip to content

Docs: AGENTS.md/GOTCHAS.md claim &+N parsing is TODO but it's implemented #287

@unclesp1d3r

Description

@unclesp1d3r

Summary

AGENTS.md and GOTCHAS.md both claim that magic-file &+N / &-N relative-offset parsing is "still TODO". This is stale — parsing has been implemented and is exercised by parse_offset_relative_* tests in src/parser/grammar/tests/mod.rs:292-305 (covers &0, &4, &+4, &-4, &0x10, &-0x10).

Locations

  • AGENTS.md:245 — "Magic-file &+N/&-N parsing is still TODO -- relative offsets are exercised programmatically through the AST."
  • GOTCHAS.md:147 (S3.11) — example uses "a child using unsupported &+N relative-offset syntax" as the canonical fail-fast trigger.

Acceptance Criteria

  • AGENTS.md "Current Limitations" → "Offset Specifications" updated to reflect that &+N/&-N parsing works
  • GOTCHAS.md S3.11 example changed to a still-unsupported syntax (e.g., $VAR substitution per S3.6, which remains a real fail-fast trigger)
  • No code changes — purely docs

Refs

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationparserMagic file parsing components and grammarpriority:lowNice to have, can defersize:XSThis PR changes 0-9 lines, ignoring generated files.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions