Skip to content

docs(mei): explain the call-filtered-out status in the docs and the report note - #541

Open
geiresx wants to merge 5 commits into
GeiserX:mainfrom
geiresx:pgp/i411-mei-filtered-status-docs
Open

geiresx wants to merge 5 commits into
GeiserX:mainfrom
geiresx:pgp/i411-mei-filtered-status-docs

Conversation

@geiresx

@geiresx geiresx commented Nov 20, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

Step 50 now writes call filtered out (LC) for a disease insertion site (FKTN, TAF1, BBS1) when MEGAnE's only calls there are ones it flagged. The reports printed that status with no word on what it means: the note under the MEI section explained not callable and not seen only. The overview table and the design brief listed three statuses. And no parity case recorded that og mei report now differs on purpose from the Python it replaced.

Fix

  • The MEI note in both renderers (rust/crates/og-render/src/notes.rs and bin/render_report.py, the same text) adds one sentence: "Call filtered out: MEGAnE called an insertion there but flagged it (LC is low confidence), so it is not a finding, and not proof of absence either."
  • docs/pipeline-overview.md, docs/design/journal/BRIEF.md and docs/50-mei.md list the status and say what the note explains. CHANGELOG.md has a line.
  • Two mei-report parity cases put an LC SVA in the FKTN window: alone (filtered), and before a PASS call in the same window (filtered-pass). The generator is tests/parity/gen/mei-filtered.sh. Each case has a golden s.tsv under tests/parity/golden/mei-report/: og writes call filtered out (LC) where the oracle wrote seen, and names the PASS call where the oracle named the first one. The calls table is the same on both sides.
  • The report-render parity oracle moves from 65095e9 to dd9290f, the commit of this PR that changes the note in both renderers.

Output change: the text and HTML reports gain that one sentence in the MEI section. No column, file or status value changes.

Decisions

  • The report-render oracle moves to dd9290f (tests/parity/oracle.ref and ORACLE_SHA in tests/parity/gen/report-corpus.sh). The old oracle still had the old note, so 48 items in 28 report-render cases would differ from og by that sentence alone. The alternative was 48 golden copies of whole reports. With the move, the Python and the Rust reports still compare byte for byte. The move also brings two later PRS wording commits and one collect_summary.py commit into the oracle; og already matches them, and every report-render case agrees (run below). This PR merges with a merge commit, so dd9290f stays in main's history.
  • Two files outside the package list: tests/parity/cases.tsv (two rows; without a row a golden is never read) and tests/parity/oracle.ref (one sha). Both are one-row mechanical files.
  • not callable keeps its name. The plan proposed renaming it to not assessed. The rename would change an output value of step 50 and needs rust/crates/og-reports/src/mei.rs, its tests and tests/e2e/mei-1.sh, which are outside this package. It means "too few reads to tell" already, and 1.0.0 prefers keeping a value to renaming it. fix(mei): mark a disease insertion seen only when MEGAnE kept the call #518 made the same call.

How it was checked

On a Mac mini, og built from this branch, the oracle in PYTHON_IMAGE under Docker:

E2E: no e2e case runs these files' code beyond the reports; the batch tip runs tests/e2e/mei-1.sh as usual.

Beads

sv-34 (the report note, the status lists and the parity record; not callable kept, see Decisions).

Step 50 now writes "call filtered out (FLAGS)" for a catalog site whose
only calls MEGAnE flagged. The note under the MEI section explained
"not callable" and "not seen" only. Both renderers now add one sentence:
MEGAnE called an insertion there but flagged it, so it is not a finding,
and not proof of absence either. The Python and Rust notes stay the same,
byte for byte.

Bead: sv-34
… did not

Two mei-report cases put a call MEGAnE flagged LC inside the FKTN window:
alone (og: call filtered out (LC); bin/mei_report.py: seen), and before a
PASS call in the same window (og names the PASS call; the oracle named
the first). Each has a golden s.tsv, so the harness fails if og goes back
to the oracle's reading, and fails as stale if the golden is changed back
to what the oracle writes. The calls table is the same on both sides.

Bead: sv-34
… note

The MEI note changed in both renderers in dd9290f. The report-render
oracle was render_report.py at 65095e9, which still had the old note, so
28 cases would differ from og only by that sentence. The oracle and the
modules it imports now come from dd9290f, where the Python and Rust
notes are the same: every report-render case still compares byte for byte.

Bead: sv-34
The MEI note must name every status a catalog row can have, and both
reports must show a "call filtered out (LC)" row with the sentence that
explains it. Red on the note before dd9290f: both tests failed.

Bead: sv-34
…e listed

The overview table and the design brief listed seen, not seen and not
callable only. docs/50-mei.md now says what the report note explains and
names the new parity cases and test. The changelog says what changed in
the reports and why not callable keeps its name.

Bead: sv-34
@coderabbitai

coderabbitai Bot commented Nov 20, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 50 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 4ee60e6 and 632a54d.

Files ignored due to path filters: 5

  • tests/parity/cases.tsv is excluded by !**/*.tsv
  • tests/parity/gen/mei-filtered.sh is excluded by !**/gen/**
  • tests/parity/gen/report-corpus.sh is excluded by !**/gen/**
  • tests/parity/golden/mei-report/filtered-pass/s.tsv is excluded by !**/*.tsv
  • tests/parity/golden/mei-report/filtered/s.tsv is excluded by !**/*.tsv
Files selected for processing: 8

  • CHANGELOG.md
  • bin/render_report.py
  • docs/50-mei.md
  • docs/design/journal/BRIEF.md
  • docs/pipeline-overview.md
  • rust/crates/og-render/src/notes.rs
  • rust/crates/og-render/tests/i411_mei_filtered_status_docs.rs
  • tests/parity/oracle.ref
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

This branch has not been deployed

No deployments
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.

2 participants