Skip to content

docs: remove cross-language and code-history commentary - #720

Merged
edkerk merged 1 commit into
develop3from
docs/remove-cross-language-and-history-comments
Sep 1, 2026
Merged

docs: remove cross-language and code-history commentary#720
edkerk merged 1 commit into
develop3from
docs/remove-cross-language-and-history-comments

Conversation

@edkerk

@edkerkedkerk commented Sep 1, 2026

Copy link
Copy Markdown
Member

Summary

Comments and docstrings across the codebase described current behavior in comparison to the Python port (raven-toolbox/raven_python), cobrapy, or geckopy, and narrated how the code changed over time (issue/PR references, "used to" framing, before/after comparisons). Rewritten to describe only the current MATLAB behavior and its rationale.

  • Functionally necessary distinctions are kept but reworded without naming the other project (e.g. io/readYAMLmodel.m/io/writeYAMLmodel.m's two supported key/field conventions are still explained, just not attributed to a specific Python tool).
  • Pure parity/comparison remarks with no other content are deleted outright (e.g. % Mirrors _node_to_dnf in raven-toolbox manipulation/expand.py.).
  • Test rationale comments (issue-number citations, "used to crash/fail" narratives) are rewritten to describe only what the test currently verifies; test logic and assertions are untouched.

Untouched by design: io/parseYAML.m's Python references (it genuinely bridges into a Python interpreter to parse YAML, a technical dependency of its own implementation, not a comparison to a sibling port); the MATLAB COBRA Toolbox references throughout (a different, MATLAB-native tool, not "the other language"); domain/algorithmic uses of words like "previously"/"no longer"/"legacy" that describe current data state or a still-supported option rather than code history.

Test plan

  • Full testing/function_tests suite (local) — 289 passed, 10 failed, 14 incomplete, reproduced identically across two separate local runs of this branch. All 10 failures are solver-configuration errors (Unrecognized field name "mipgap") in tAnalysis/tAssignCompartments/tGapfilling/tINIT -- none in a file this PR touches. On a pristine, unmodified develop3 checkout in the same local environment, these same test classes were instead skipped outright (Filtered by assumption, solver-availability gated) rather than attempted -- consistent with local solver-detection/configuration flakiness, not a regression from this change, but not a byte-for-byte reproduction either. Deferring to CI for the authoritative signal here.
  • The 14 incomplete are all Filtered by assumption (missing optional deps: quadprog, Python/pyyaml, KEGG data files) -- pre-existing skips.

Comments and docstrings across the codebase described the current
implementation's behavior in comparison to the Python port
(raven-toolbox/raven_python), cobrapy, or geckopy, and narrated how the
code changed over time (issue/PR references, "used to" framing,
before/after comparisons). Rewritten to describe only the current
MATLAB behavior and its technical rationale; functionally necessary
distinctions (e.g. between two supported file-format conventions) are
kept but reworded without naming the other project.
@github-actions

Copy link
Copy Markdown

Function test results

304 tests 277 ✅ 1m 15s ⏱️
25 suites 27 💤
1 files 0 ❌

Results for commit 131082c.

@edkerk
edkerk merged commit 0cf30f9 into develop3Sep 1, 2026
4 checks passed
@edkerk
edkerk deleted the docs/remove-cross-language-and-history-comments branch September 1, 2026 11:54
Sign up for freeto 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

@edkerk