docs: cite Yung+24/25 on colossus comparison, fix Yung24 ref#318
Merged
Conversation
Aaron Yung and Miguel Vargas noticed the hmf/Colossus Tinker08 discrepancy while preparing their papers, which led directly to the growth-factor fix. Add a note and citations crediting them on the comparison page, using the repo's existing reST citation convention (no bibliography file exists to extend). Also fixes the Yung24 fitting-function `_ref` string, which had the wrong author list and MNRAS volume/page for arXiv:2309.14408 (should be Yung, Somerville, Nguyen, Behroozi, Modi, Gardner, MNRAS 530, 4868, not the previously listed authors and MNRAS 527, 5929).
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #318 +/- ##
=======================================
Coverage 97.89% 97.89%
=======================================
Files 26 26
Lines 2710 2710
=======================================
Hits 2653 2653
Misses 57 57 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
steven-murray
added
the
type: maint: documentation
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.
Description
Aaron Yung and Miguel Vargas independently noticed the hmf/Colossus Tinker08 disagreement while preparing their papers, and that report is what led to the growth-factor fix (#270) and the follow-up threshold tightening in v3.6.1. They've given permission to cite their work on the comparison page.
This PR:
docs/technical/colossus_comparison.rstcrediting Yung and Vargas, with proper citations to:[Label]_citations + aReferencessection, as used ingrowth_factors.rst) — there's noCITATIONS.bib/CITATION.cffin the repo to extend, so no new bibliography format was introduced.Yung24._refinsrc/hmf/mass_function/fitting_functions.pycited the wrong author list (Finkelstein/Wilkins instead of Nguyen/Behroozi/Modi) and the wrong MNRAS volume/page (527, 5929 instead of 530, 4868) for arXiv:2309.14408.Issues
N/A
Checklist
I have