docs: clarify calculateMW and reportEnzymeUsage docstrings - #461
Merged
edkerk merged 1 commit intoAug 30, 2026
Merged
Conversation
- calculateMW: state the MW unit (Da) explicitly. - reportEnzymeUsage: remove the redundant repeated summary line, tighten the highCapUsage/topAbsUsage descriptions, document that topAbsUsage omits enzymes with no flux-carrying reactions, and correct the Returns section to describe the actual struct fields (it previously just said "table with summary information", but usageReport is a struct with two tables and a scalar).
Unit test results46 tests 46 ✅ 8s ⏱️ Results for commit f37381d. |
edkerk
deleted the
docs/clarify-calculatemw-and-reportenzymeusage-docstrings
branch
August 30, 2026 21:41
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Small follow-up to #459 and #460 (both already merged): tightens the
docstrings on the two touched functions so the output is clear to an
end-user without needing to read the implementation.
highCapUsage/topAbsUsagedescriptions to be more directtopAbsUsagenever lists enzymes with no flux-carryingreactions (the behavior added in fix: reportEnzymeUsage skips only fully-inactive enzymes in topAbsUsage #460)
Returnssection, which saidusageReport : table with summary informationeven thoughusageReportis a struct with twotables (
highCapUsage,topAbsUsage) and a scalar (totalUsageFlux)No functional changes -- comment/docstring only.