Skip to content

docs: preflight.ts comment falsely claims compress renumbers surviving refs #595

Closed

Description

@ranxianglei

Problem

The round-loop comment in src/preflight.ts (~:365) still says:

Re-run the pipeline each round: every successful compress renumbers the surviving refs, so the previous round's range refs are stale.

That was true before the #387 work, but refs are stable per-session snapshots now — what changes across rounds is which ranges remain compressible under them, not the numbering.

Impact

The comment invites wrong "fixes" (re-adding renumbering logic, caching by ref) and misdocuments the core invariant. Docs-only.

Suggested fix

Reword the comment to the #387-era semantics. PR #578 carries the exact 4-line reword (merges clean against master).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions