docs: LaTeX docstrings for all mass profile classes#453
Merged
Conversation
Add Sphinx-compatible LaTeX docstrings with mathematical definitions, paper references, and parameter descriptions to every mass profile class: total (Isothermal, PowerLaw, dPIE families), dark (NFW, gNFW, cNFW), stellar (Sersic, Gaussian, Chameleon), sheets (ExternalShear, MassSheet, ExternalPotential), point (PointMass, SMBH, SMBHBinary), and abstract decomposers (MGEDecomposer, MassProfileCSE). 26 files, 1283 insertions. Documentation only — no code logic changed. Phase 5 (final) of mass profiles refactoring epic (#445). Co-Authored-By: Claude Opus 4.7 <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.
Summary
Add Sphinx-compatible LaTeX docstrings with mathematical definitions, paper references, and parameter descriptions to every mass profile class in PyAutoGalaxy. Covers total (Isothermal, PowerLaw, dPIE), dark (NFW, gNFW, cNFW), stellar (Sersic, Gaussian, Chameleon), sheets, point masses, and abstract decomposers (MGE, CSE). 26 files, ~1300 lines of documentation. Phase 5 (final) of the mass profiles refactoring epic (#445).
API Changes
None — documentation only. No code logic changed.
Test Plan
pytest test_autogalaxy/profiles/mass/— 406 passed, 0 failedr"""raw strings for LaTeX compatibility.. math::directives used throughout🤖 Generated with Claude Code