Trim docs and comments to current-state-only prose - #716
Merged
Conversation
Help blocks, inline comments, and top-level docs across the codebase described how things got here instead of just what's true now: version/PR history, "previously X now Y" narration, dated asides, migration-era provenance notes, and general hedging/AI-speak padding. Cut all of that. Kept every load-bearing rationale (MILP formulations, numerical gotchas, platform/solver limitations, correctness warnings) and all parameter/return documentation as-is. Left already-terse files untouched. Comments and docstrings only; no functional code changed.
Function test results303 tests 276 ✅ 1m 7s ⏱️ Results for commit ec06919. ♻️ This comment has been updated with latest results. |
Reviewed every help-block against end-user usefulness: does it say what the function produces, and does it explain what each non-obvious parameter controls, without narrating internal algorithm steps. Fixes a few inaccuracies found along the way: ftINITFillGaps documented a parameter that doesn't exist in its signature, groupRxnScores had the groupIds convention backwards, and haveFlux's documented cutOff default didn't match the code.
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.
Summary
Full-codebase pass over help blocks, inline comments, and top-level docs (229
.mfiles + 7 markdown files reviewed; 49 changed). Cut:Kept as-is:
analysis/,gapfilling/,solver/, etc. — left untouched).Generated documentation (
doc/), vendored third-party code (software/), license text, and the changelog were out of scope entirely.Comments and docstrings only — no functional code touched (verified: every changed line in every file is either inside a
%-comment or a trailing comment on an otherwise-unchanged code line).Test plan
testing/function_tests/*full suite — 298 passed, 0 failed, 8 filtered (pre-existing environment gates: missing quadprog/network data/Parallel Computing Toolbox branches, unrelated to this change)