Repository navigation
docs: list the public Parallax and Ptychography types in DocC topics - #50
Merged
Merged
Conversation
CuboParallax: the streamed preprocessing result, stack retention, the aberration fit options, results and method, the physical shift, the basis convention and the highpass behaviour now sit in the Preprocessing and Aberrations groups. CuboPtycho: a new Preparation group (preparation options, prepared result, scan geometry, origins, padding, shift, amplitudes), the precision, error normalisation and position correction under Processing, and an Errors group with MixedstateZeroPixelError. PtychographyPreparationOptions and PreparedPtychography were missing too and are listed. Fixes #33 Done: every top-level public type of both modules is in a Topics group. Next: none for this issue. Co-Authored-By: Claude Opus 5.5 <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
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.
Requested by Paul · project thread
Fixes #33
Adds the missing public types to the Topics groups of the CuboParallax and CuboPtycho landing pages.
ParallaxStreamedPreprocessingResultandParallaxStackRetentionunder Preprocessing; the fit method, low- and higher-order options and results,ParallaxPhysicalShift,ParallaxBasisConventionandParallaxHighpassBehaviorunder Aberrations.PtychographyPreparationOptionsandPreparedPtychography, which were missing too), precision / error normalisation / position correction under Processing, and an Errors group withMixedstateZeroPixelError.Check: a grep of every top-level
publictype in both modules against the two landing pages now finds none unlisted. The Docs workflow builds the catalogues on this PR.🤖 Generated with Claude Code