docs: fix stale default-off comments for RPS / precipitation regulation#21
Merged
Conversation
The default flip (c33be43) updated the RamPressureStrippingOn struct comment and the read-parameter default comments but left several places still describing the old off-by-default state: - core_allvars.h PrecipRegulationOn struct comment (said 0=DEFAULT) - model_ram_pressure.c header (said default 0) - docs/parameters.md RamPressureStrippingOn default column (0 -> 1) and a missing PrecipRegulationOn row (now added) - docs/physics/infall.md two RamPressureStrippingOn default mentions Comment/doc only -- no output change.
MBradley1985
added a commit
that referenced
this pull request
Jul 5, 2026
Bring README, CHANGELOG, and the RTD physics docs up to date with the now-default-on channels merged in #20/#21: - CHANGELOG.md: new top entry covering ram-pressure ISM stripping, the self-regulating precipitation law, the AGN/CGM overdraw bugfix, and the intentional default flip with regenerated baselines. - README.md: RamPressureStrippingOn + PrecipRegulationOn added to the 'what is new' table, a satellite ram-pressure stripping subsection, and the precipitation-regulation row in the CGM table. - docs/physics/cooling_and_heating.md: precipitation self-regulation (M_eq / free-fall shut-off), the PrecipRegulationOn switch, and the post-accretion coolingGas re-cap. parameters.md and infall.md were already updated in #20/#21. RTD build verified locally (doxygen + sphinx, all pages render clean).
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.
Follow-up to PR #20. Comment/doc-only fix: several places still described
RamPressureStrippingOnandPrecipRegulationOnas off-by-default after the default flip. Corrects thePrecipRegulationOnstruct comment, themodel_ram_pressure.cheader, thedocs/parameters.mddefault column, adds the missingPrecipRegulationOndocs row, and fixes two mentions indocs/physics/infall.md. No output change.