Repository navigation
docs: simplify the model figure prose to two fixed paragraphs - #738
Merged
Merged
Conversation
Replace the map/legend prose block beside every `af.ModelPlotter` figure with two fixed paragraphs, deleting the file-specific reading commentary that followed it, and strip the same figure-rendering vocabulary (pills, plates, badges, greyed pills, footer counts) from the shorter notes at later figure sites. The human's verdict: the commentary is information overload and the figure should be self-explanatory. Teaching content that happened to sit inside those blocks is preserved, reworded to stand on its own without referring to the figure's vocabulary. The EP factor-graph blocks are exempt: box / pill / edge is standard probabilistic-graphical-model notation, and the state overlay carries per-factor update counts, ages and statuses that `graph.info` does not provide. Image `:alt:` text is exempt too, since describing what a figure looks like is its purpose. Issue: PyAutoLabs/autofit_workspace#156 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LPCvGNHahZqynPyEfMijsb
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
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.
Docs Changed
docs/general/model_cookbook.mddocs/overview/overview_3_features.mdDocumentation only — no source, no API change.
Section rewritten, not deleted:
## Solved Parametersbecomes## Solved and Unconfigured Parametersand keeps every fact — a linear profile'sintensitysolved by the inversion, aBasisowning no amplitude of its own,al.Pixelization.reconstructionsolved with regularization coefficients its only sampled parameters,al.ps.PointSolved.centresolved analytically whereal.ps.Pointsamples it, andareas_factorhaving no configured prior so the model cannot be fitted until one is supplied. The pill/dash/colour framing is gone.Removed: the
## Reading the Figuresection, and the cross-reference that pointed at it.Sphinx: 131 warnings before and after, against a
mainbaseline built in the same environment. Note that the recorded baseline of 134 is stale:mainitself builds 131 in this environment.What changed
Every
af.ModelPlotterfigure was accompanied by a prose block — an opener, a map/legend paragraph, and one or more paragraphs describing what that particular figure shows ("the greyedradius_breakpills on the source are fixed values, which is the difference between the footer's count of sampled scalars and the number of pills drawn"). That block is replaced everywhere by two fixed paragraphs:The shorter notes at second and third figure sites keep their place but lose the same vocabulary — pills, plates, badges, greyed, footer counts — retaining only statements of fact about the model.
What was deliberately kept
graph.infodoes not provide. This is not the redundancy being removed.:alt:text andmake_figures.pygenerator docstrings are exempt: describing how a figure looks is the whole job of alt text, and stripping it would degrade screen-reader accessibility.Verification
scripts/*.py,notebooks/*.ipynbanddocs/**/*.md: zero non-exempt occurrences of**map**,**legend**, pill, badge, plate, chip, greyed or footer-count language.PyAutoHands/autohands/generate.py, never hand-edited;check_navigator.pypasses.No API changes — documentation and example prose only.
🤖 Generated with Claude Code
https://claude.ai/code/session_01LPCvGNHahZqynPyEfMijsb