Fix incorrect and misleading comments across src/#1624
Open
BakaOverflow wants to merge 1 commit into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1624 +/- ##
=======================================
Coverage 60.39% 60.39%
=======================================
Files 83 83
Lines 19854 19854
Branches 2955 2955
=======================================
Hits 11990 11990
Misses 5863 5863
Partials 2001 2001 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
Description
Fixes seven incorrect or misleading comments across
src/, as listed in #1497. All changes are comment-only — no executable code, logic, or formatting was touched.m_helper.fpp(double_factorial, factorial):selected_int_kind(18)requests 18 decimal digits, not 18 bytes — corrected both.m_collisions.fpp: module@briefwas copy-pasted from an IBM module; rewrote it to describe the module's actual collision-force handling.m_data_output.fpp:Rc_mintracks a minimum (minval,Rc_min_glb < Rc_min), so "maximum" → "minimum".m_derived_types.fpp:p0/m0are bubble pressure/mass; comments said size/velocity (copied fromR0/V0).m_riemann_solver_hllc.fpp: removed a duplicate "HLLC".m_precision_select.f90: clarifiedhalf_precisionis a hardcoded kind (its siblings are computed viaselected_real_kind).m_mpi_common.fpp: fixed a dangling "and."; removed a duplicates_mpi_reduce_maxlocsummary line.Note: the issue cited
m_riemann_solvers.fpp:1779for item 5, but that module was split into per-scheme files after the issue was filed, so the fix lands inm_riemann_solver_hllc.fpp. A few other line numbers had also drifted and were re-verified against currentmaster.Closes #1497.
Type of change (delete unused ones)
Testing
Comment-only change with no runtime behavior, so there's nothing to unit-test. Validated that the diff is comment-only and the project's checks pass:
./mfc.sh format(no reformatting),./mfc.sh lint(ruff + 349 toolchain tests passed), and the pre-commit precheck (same as the CI lint-gate) passed all seven gates (formatting, spell check, toolchain lint, source lint, doc references, parameter docs, example cases).Checklist