Skip to content

docs: tutorial-completeness CI check + normalize tutorials (phase 3)#16

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/restore-truncated-howto-tutorials
Jul 11, 2026
Merged

docs: tutorial-completeness CI check + normalize tutorials (phase 3)#16
Jammy2211 merged 1 commit into
mainfrom
feature/restore-truncated-howto-tutorials

Conversation

@Jammy2211

Copy link
Copy Markdown
Contributor

Overview

Phase 3 (HowToFit) of PyAutoLabs/HowToLens#26 — applying the tutorial-completeness guard to HowToFit. No genuinely-truncated tutorials were found here; the work is normalizations + the CI check.

What changed

  • Prevention: .github/scripts/check_tutorials_complete.py + tutorials_complete.yml CI — every non-stub tutorial must contain a terminal __Wrap Up__/__Summary__ section. A truncated script never reaches its wrap-up, so absence of the marker reliably flags lost content.
  • Normalization: four complete-but-unmarked tutorials get the terminal marker so they pass the check:
    • tutorial_5_results_and_samples — ended on a bare Finish. docstring; replaced with a real __Wrap Up__.
    • tutorial_optional_hierarchical_individual — ended on a prose conclusion; add the marker.
    • tutorial_5_expectation_propagation and tutorial_optional_hierarchical_ep — both end on intentional optional commented-out example code (mean-field inspection / the expensive EP optimise call, commented for cost). A __Wrap Up__ section is appended that frames the commented code as optional, so the tutorials read as complete without removing the reference snippets.
  • Notebooks + navigator catalogue regenerated (catalogue titles unchanged → no catalogue diff).

Scripts Changed

  • scripts/chapter_1_introduction/tutorial_5_results_and_samples.py — replace bare Finish. with a real __Wrap Up__
  • scripts/chapter_3_graphical_models/tutorial_optional_hierarchical_individual.py — add __Wrap Up__ marker (already complete)
  • scripts/chapter_3_graphical_models/tutorial_5_expectation_propagation.py — append __Wrap Up__ (ends on optional commented code)
  • scripts/chapter_3_graphical_models/tutorial_optional_hierarchical_ep.py — append __Wrap Up__ (ends on optional commented code)
  • .github/scripts/check_tutorials_complete.py — new tutorial-completeness linter
  • .github/workflows/tutorials_complete.yml — new CI workflow running the linter
  • notebooks/** — regenerated

Validation checklist (--auto)

  • Tests: n/a — tutorial/doc repo, no pytest suite; no library API touched.
  • Smoke: PASS — curated smoke_tests.txt 10/10 (including edited tutorial_5_expectation_propagation), run on this branch.
  • Review: CLEAN — self-review; docstring-only marker normalizations (no code changed).
  • Heart: YELLOW acknowledged by the maintainer in-session (identical 6-reason ambient set as HowToLens#27, unrelated to HowToFit).
  • Completeness check: all 12 tutorials pass.

Final part of the 3-repo rollout (HowToLens #27 → HowToGalaxy #19 → this). With all three merged, HowToLens#26 can close.

🤖 Generated with Claude Code

https://claude.ai/code/session_01KExk2jkn2ya21b6NZLALpB

…ToLens#26)

Apply the tutorial-completeness guard from HowToLens to HowToFit:

- Add .github/scripts/check_tutorials_complete.py + tutorials_complete.yml CI —
  every non-stub tutorial must reach a terminal __Wrap Up__/__Summary__ section.
- Normalize four complete-but-unmarked tutorials with the terminal marker:
  tutorial_5_results_and_samples (ended on a bare "Finish." docstring),
  tutorial_optional_hierarchical_individual (prose conclusion),
  tutorial_5_expectation_propagation and tutorial_optional_hierarchical_ep (both
  end on intentional optional commented-out example code — a wrap-up section is
  appended framing that code as optional).

No genuinely-truncated tutorials were found in HowToFit. Smoke 10/10.
Notebooks + catalogue regenerated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KExk2jkn2ya21b6NZLALpB
@Jammy2211 Jammy2211 added the pending-release PR queued for the next release build label Jul 11, 2026
@Jammy2211 Jammy2211 merged commit 358e37c into main Jul 11, 2026
10 checks passed
@Jammy2211 Jammy2211 deleted the feature/restore-truncated-howto-tutorials branch July 11, 2026 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pending-release PR queued for the next release build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant