docs: document the functional plot API in plot.rst#494
Merged
Conversation
Follow-up to the #592 prune of the removed OO plotting subsystem. Adds a 'Plot Customization' section documenting the functional interface (title/ colormap/use_log10/output_path/output_filename/output_format kwargs on any aplt.* call; config/visualize YAML for defaults) and a 'Figure Output' section for the surviving autoarray.plot.Output object. Re-audit clean. Issue PyAutoLabs/PyAutoLens#595. Co-Authored-By: Claude Opus 4.8 <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
Documents the functional plot API in
docs/api/plot.rst— the positive follow-up to PyAutoLabs/PyAutoLens#592, which pruned the removed OO plotting subsystem and left the reference thin.Adds two sections:
aplt.*function (title,colormap,use_log10,output_path,output_filename,output_format); there is noMatPlot2D/Cmapobject anymore. Defaults come from the workspaceconfig/visualizeYAML.autoarray.plot.Outputobject.Grounded against the installed API (
dir(autogalaxy.plot),dir(autoarray.plot)) andautolens_workspace/scripts/guides/plot/start_here.py.Validation checklist (--auto, supervised)
docs/api/plot.rst).Output) resolves;docutilsparses the file; CRLF preserved.Autonomous run ended at PR-open (maintainer pre-authorized "both --auto to PR-open"); merge stays human. PyAutoFit's
plot.rstdeferred behind ep-graphical-docs #1334. Issue PyAutoLabs/PyAutoLens#595.🤖 Generated with Claude Code