docs(api): sync light profile reference with PyAutoGalaxy - #516
Merged
Conversation
Add the previously missing Linear, Operated, and Basis autosummary sections to docs/api/light.rst and add the one-line description to the Standard section. After this change the file is byte-identical to PyAutoGalaxy/docs/api/light.rst. The SersicMultipole and GaussianMultipole profiles merged via #515 (and their PyAutoGalaxy linear variants) are exposed on al.lp_linear.* but previously had no entry on the PyAutoLens API reference page. This brings the docs in line. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
Collaborator
Author
|
Workspace PR: PyAutoLabs/autogalaxy_workspace#86 |
Collaborator
Author
|
Workspace PR: PyAutoLabs/autolens_workspace#176 |
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
Brings
docs/api/light.rstinto structural parity with PyAutoGalaxy's equivalent — addsthe previously missing
Linear [``ag.lp_linear``],Operated [``ag.lp_operated``], andBasis [``ag.lp_basis``]autosummary sections, and adds the one-line description to theStandardsection. After this PR the two files are byte-identical.Motivation: the
SersicMultipole/GaussianMultipoleprofiles merged via #515 (and theupstream PyAutoGalaxy linear variants) are exposed on
al.lp_linear.*but had no APIreference entry on the PyAutoLens docs site. Users browsing the autolens docs could not
discover the linear, operated, basis, or multipole-linear variants from the API page.
Part of #85 on
autogalaxy_workspace— this is the library-side prerequisite before thenew
scripts/guides/profiles/light.pyis added to the two workspaces.API Changes
None — docs-only change. No Python code is modified, no symbols added or removed. The
new autosummary entries point at classes that already exist in
autogalaxy.profiles.light.*and are already re-exported byautolensasal.lp_linear,al.lp_operated,al.lp_basis.See full details below.
Test Plan
docs/api/light.rstandPyAutoGalaxy/docs/api/light.rstdiffer by zero bytesbaseline sanity check)
light.rstFull API Changes (for automation & release notes)
Added
docs/api/light.rstLinear section listing the 14ag.lp_linearprofiles documentedin PyAutoGalaxy (including the newly merged
GaussianMultipoleandSersicMultipolelinear variants)
docs/api/light.rstOperated section listingag.lp_operated.Gaussian,Moffat,Sersicdocs/api/light.rstBasis section listingag.lp_basis.BasisRemoved
Renamed
Changed Signature
Changed Behaviour
Migration
🤖 Generated with Claude Code