docs: move the VLE physics equations to the example page; fix a grammar slip - #3
Merged
Conversation
…re scarce"
- index.md: "data is scarce" -> "data are scarce" ("data" as a plural noun).
- Move "The example: extended Raoult's law and Gibbs-Duhem" off the Theory page and
onto the VLE/distillation example page as "The governing equations", placed right
after "The physics" so Eqs (10)/(11) and the SI-4 column closures sit next to the
four components they describe. The Theory page is now purely about the method, and
keeps a short cross-reference explaining that the example's thermodynamics lives on
the example page because bits_for_gaps never sees it -- only the black-box activity
coefficient.
sphinx-build -W clean; both equations and the typo fix verified in the rendered HTML.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Two small documentation improvements, no code changes.
Move the example's physics to the example page. The Theory page ended with a section
stating extended Raoult's law (Eq 10), the Gibbs–Duhem relation (Eq 11), and the SI-4
McCabe–Thiele column closures. Those are properties of the case study, not of the method —
bits_for_gapsnever sees them; it only ever sees the black-box activity coefficient. Theynow live on the VLE/distillation example page as "The governing equations", directly after
"The physics", so each equation sits beside the component it describes. The Theory page
keeps a short cross-reference so the material is still discoverable.
Grammar. "which matters most exactly when data is scarce" → "data are scarce".
Verified:
sphinx-build -Wclean, and both equations plus the corrected sentence confirmedin the rendered HTML.
🤖 Generated with Claude Code