Repository navigation
docs: introduce potential correction science and illustration - #829
Merged
Merged
Conversation
This was referenced Nov 12, 2026
Merged
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.
Summary
Introduce potential correction through arc residuals, candidate perturbations and lens-model flexibility while retaining technical teaching. Clarify corrections relative to a smooth baseline, distinguish the controlled simulation from scientific applications, preserve implementation attribution and consolidate related examples. Use the approved two-panel illustration across feature, tour and RTD.
API Changes
None. Adds a distinct Potential Correction overview after Sensitivity Mapping, plus illustration and provenance.
Validation
Fresh checks passed: syntax, executable AST and generated notebook code-cell parity, approved feature-text parity (image path only), identical approved two-panel image assets, local image links, navigator/banner lint, search-memory check, script-size guard, whitespace and focused Sphinx build with warnings treated as errors. All eight narrative blocks and original unique headings retained; repeated Related Examples consolidated. No API or executable changes. Full numerical/smoke suites were not rerun for this prose/assets-only patch; preceding sensitivity-mapping PRs passed all 12 exact-head CI jobs, which are prior evidence rather than fresh tests.
Related: PyAutoLabs/autolens_workspace#636. Review PR only; no merge authorized.
Development-only Heart RED override
Human authorization (2026-11-12): “I approve the development-only Heart RED override for #636. Commit, push and open both PRs for review, don't merge yet.”
Exact RED reasons (2026-11-12T15:25:16.865951+00:00):
PyAutoLens: on branch feature/potential-correction-review (not main)PyAutoLens: 2 uncommitted source change(s)Fresh checks passed: syntax, executable AST and generated notebook code-cell parity, approved feature-text parity (image path only), identical approved two-panel image assets, local image links, navigator/banner lint, search-memory check, script-size guard, whitespace and focused Sphinx build with warnings treated as errors. All eight narrative blocks and original unique headings retained; repeated Related Examples consolidated. No API or executable changes. Full numerical/smoke suites were not rerun for this prose/assets-only patch; preceding sensitivity-mapping PRs passed all 12 exact-head CI jobs, which are prior evidence rather than fresh tests.
Commit, push and PR-open only; no merge, release or CI bypass.
Companion workspace PR: PyAutoLabs/autolens_workspace#637