docs: registration-prep documentation fixes (api_overview, agent-guide page, CITATION.cff) - #48
Merged
Merged
Conversation
…e page, CITATION.cff) api_overview.md: FitInfo -> GaussMLEFitInfo; elapsed_ns -> elapsed_s on every info struct; stale upstream field lists completed; native info types listed; corrected defaults (DriftConfig maxn=100, BaGoLConfig n_iterations=4000 / posterior_pixel_size=0.001 / se_adjust, FilterConfig all-nothing + z/sigma_z, IntensityFilterConfig full field list, DetectFitConfig datasets/pixel_size/qe/ movie_fps, AnalysisConfig.checkpoint, MultiTargetConfig.verbose, MultiTargetResult.step_infos/outdir); step-info table de-Dict'ed; save_pipeline_state step_records -> step_infos; load_smart_h5 documented as a single-array return (the old destructuring line silently bound pixel values). docs: new workflows/agent_guide.md (install/uninstall/agent_guide_status were on no page); get_images in api/io.md; install.md verify snippet now runnable and docs-build recipe no longer runs Pkg.develop(path=".") (rewrote the tracked docs/Project.toml); composite_render clip_percentile default :auto; crosscorr zero-distance pairs kept + per-channel FOV; intensityfilter p2 :mixture default; guide/extending/references/tutorial stale statements. README: Requirements paragraph; ecosystem tree lists SMLMBaGoL + SMLMClustering. CITATION.cff added. New fast test: every SMLMAnalysis-owned export must appear in a @docs block under docs/src. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Member
Author
|
Local verification (kitt, Julia 1.12.6):
|
The package's declared floor is julia = "1.10", and since SMLMFrameConnection 0.3.4 (registered 2026-09-06) the whole stack actually resolves and passes CI on Julia 1.10. The two pages that stated 1.12 were describing the old, unsatisfiable state. Co-Authored-By: Claude Fable 5.1 <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.
Documentation, README, api_overview, and citation fixes from the 2026-09-05 registration-readiness review (
dev/output/registration_readiness_20260905.md, items C1–C4, D6). Companion to #47 (code + CI); independent of it.api_overview.md(root AI-parseable reference) — every item verified against the live moduleFitInfo→GaussMLEFitInfo(the former does not exist);elapsed_ns::UInt64→elapsed_s::Float64on all 7 info structs; stale field lists ofBoxesInfo/FrameConnectInfo/DriftInfo/RenderInfocompleted (n_rois,n_filtered+calibration,roi_indices+residual_correlation,scalebar_length_um); a native-info-types list added.DriftConfig(maxn=100),BaGoLConfig(n_iterations=4000, posterior_pixel_size=0.001)(+se_adjust),FilterConfigcriteria all default tonothing(+z,sigma_z),IntensityFilterConfigfull field list (p2_method=:mixture…),DetectFitConfig(+datasets,pixel_size,qe,movie_fps),AnalysisConfig.checkpoint,MultiTargetConfig.verbose,MultiTargetResult.step_infos/outdir.steps-Dict residue (:filter → nothing,:detectfit → tuple); now the real types.save_pipeline_state(...; step_records)→step_infos(the old kwarg throws).data, info = load_smart_h5(path)→ that function returns ONE array, so the old line silently bound two pixel values; now documents the single return and points tosmart_h5_to_arrayfor the pair.Docs (
docs/src)workflows/agent_guide.md—install_agent_guide/uninstall_agent_guide/agent_guide_statuswere exported and advertised in the README but on no page of the manual.get_imagesadded to the I/O@docs.install.md: the "verify the install" snippet now actually runs (it referenced undefinedcam/images); the docs-build recipe no longer runsPkg.develop(path="."), which rewrote the trackeddocs/Project.tomlwith an absolute path; registration note reworded (all deps are registered).composite_render.md:clip_percentiledefault is:auto, not0.99.crosscorr.md: zero-distance pairs are kept (bin 1), not skipped; channel-B density uses B's own FOV with a mismatch warning.intensityfilter.md: p₂ section described only the legacy:tailestimator; the default is the threshold-free:mixturefit — concept text + table row.guide.md("unregistered dependencies"),extending.md(danglingCONTRIBUTINGreference),references.md(promisedCITATION.bib),tutorial.md(two wording nits).README / repo
CITATION.cffadded (GitHub "Cite this repository"). Please check the author entry (name/affiliation; add an ORCID if wanted) — it is my best guess fromProject.toml.Guard
New fast test: every symbol defined in SMLMAnalysis (not re-exported) must appear in a
@docsblock underdocs/src— the scoped check thatcheckdocs=:nonecannot provide. It is what would have caught the four missing pages.Local: fast tests green; full Documenter build (
warnonly=false) green — see PR comment for the run outputs.🤖 Generated with Claude Code