Skip to content

docs: document the functional plot API in plot.rst - #494

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/plot-rst-functional-rewrite
Jul 9, 2026
Merged

Jammy2211 merged 1 commit into
mainfrom
feature/plot-rst-functional-rewrite

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

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:

  • Plot Customization — customization is by keyword arguments passed directly to any aplt.* function (title, colormap, use_log10, output_path, output_filename, output_format); there is no MatPlot2D/Cmap object anymore. Defaults come from the workspace config/visualize YAML.
  • Figure Output — the surviving autoarray.plot.Output object.

Grounded against the installed API (dir(autogalaxy.plot), dir(autoarray.plot)) and autolens_workspace/scripts/guides/plot/start_here.py.

Validation checklist (--auto, supervised)

  • Tests: n/a — zero Python source changed (single docs/api/plot.rst).
  • Smoke: n/a — no downstream script surface.
  • Review: CLEAN — re-audit confirms every autosummary entry (the new Output) resolves; docutils parses the file; CRLF preserved.
  • Heart: YELLOW — reason set ⊆ the chronic set the maintainer acknowledged at the feat: prior configs + docs for the AdaptPower regularization siblings #592 ship (workspace-validation stale-fail, 58 parked scripts, assistant pin-behind, 10d Mind PR); none from this change, none RED.

Autonomous run ended at PR-open (maintainer pre-authorized "both --auto to PR-open"); merge stays human. PyAutoFit's plot.rst deferred behind ep-graphical-docs #1334. Issue PyAutoLabs/PyAutoLens#595.

🤖 Generated with Claude Code

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>
@Jammy2211 Jammy2211 added the pending-release PR queued for the next release build label Jul 9, 2026
@Jammy2211
Jammy2211 merged commit 15f8c79 into main Jul 9, 2026
4 checks passed
@Jammy2211
Jammy2211 deleted the feature/plot-rst-functional-rewrite branch July 9, 2026 16:17
@Jammy2211 Jammy2211 removed the pending-release PR queued for the next release build label Sep 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant