Skip to content

Fix the stale merge_compartments note left behind on 16.4 - #48

Merged
edkerk merged 1 commit into
mainfrom
fix/combining-stale-bug-note
Aug 29, 2026
Merged

Fix the stale merge_compartments note left behind on 16.4#48
edkerk merged 1 commit into
mainfrom
fix/combining-stale-bug-note

Conversation

@edkerk

@edkerk edkerk commented Aug 29, 2026

Copy link
Copy Markdown
Owner

Found while pulling after #46 — this is exactly the drift
#41 warns about, already live
on main.

8f0430a regenerated 16.4's output blocks after the submodule bump, but the
prose beneath them still described the old behaviour. Two problems:

1. It rendered as a code block. The !!! danger header line was removed and
its indented body left behind, so three paragraphs of prose showed up as
preformatted text.

2. It contradicted the output directly above it. The text said "of the 11
reactions it drops above, only 3 are genuine transports" — the example now prints
3 — and "until the fix ships", when
raven-toolbox#96 is
merged and present in the tracked commit 173131d1. A reader would have been
told the Python tab was broken while looking at output showing it is not.

What it says now

A note explaining what the two tabs really show: both end at 50 reactions,
but RAVEN reports 0 removals and raven-toolbox 3 (CAT2, CO2TRANS,
ShuttleX). Same three reactions either way — RAVEN clears them when it removes
reactions the merge left empty, and its deletedRxns counts only what the
deleteRxnsWithOneMet path deleted, which is nothing while that flag is false
by default. The exchange-deletion bug is recorded in the past tense with the PR
that fixed it.

Verified: the built page now renders an admonition rather than a code block, and
check_names.py is clean (deletedRxns allow-listed as a variable).

Worth noting for #41

The examples themselves were fine — CI has been green because --update already
corrected the numbers. It is the surrounding prose that went stale, which nothing
checks. That is the part of the regeneration that needs a person, and this is a
concrete instance of it.

8f0430a regenerated this section's output blocks after the submodule
bump but left the prose beneath them describing the old behaviour. Two
things were wrong.

The admonition's header line was deleted while its indented body stayed,
so the paragraphs rendered as a code block rather than a note.

The text itself no longer matched the output above it. It said "of the
11 reactions it drops above, only 3 are genuine transports" where the
example now prints 3, and "until the fix ships" after the fix had
shipped: SysBioChalmers/raven-toolbox#96 is merged and is in the
tracked commit.

Replaced with a note that explains what the two tabs actually show --
both end at 50 reactions, RAVEN reporting 0 removals and raven-toolbox
3, because RAVEN's deletedRxns counts only the deleteRxnsWithOneMet
path, which is off by default. The exchange-deletion bug is recorded in
the past tense, with the PR that fixed it.
@edkerk
edkerk merged commit 3334da7 into main Aug 29, 2026
2 checks passed
@edkerk
edkerk deleted the fix/combining-stale-bug-note branch August 29, 2026 21:35
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