docs: tutorial-completeness CI check + stub/normalize tutorials (phase 2)#19
Merged
Merged
Conversation
…ToLens#26) Apply the tutorial-completeness guard from HowToLens to HowToGalaxy: - Add .github/scripts/check_tutorials_complete.py + tutorials_complete.yml CI — every non-stub tutorial must reach a terminal __Wrap Up__/__Summary__ section (a truncated script never does, so absence of the marker flags lost content). - Fill the empty tutorial_4_methods.py (0 bytes since the bootstrap commit, no source to restore) with a "not written yet" stub, matching the HowToLens stub convention. - Normalize three complete-but-unmarked tutorials with the terminal marker: tutorial_4_dealing_with_failure, tutorial_4_bayesian_regularization, tutorial_searches. No genuinely-truncated tutorials were found in HowToGalaxy (its ch1 tutorial_1 is the complete 654-line reference used to restore the HowToLens sibling). Smoke 4/4. Notebooks + catalogue regenerated. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KExk2jkn2ya21b6NZLALpB
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
1 participant
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.
Overview
Phase 2 (HowToGalaxy) of PyAutoLabs/HowToLens#26 — applying the tutorial-completeness guard to HowToGalaxy. No genuinely-truncated tutorials were found here (its
tutorial_1_grids_and_galaxiesis the complete 654-line reference that was used to restore the HowToLens sibling); the work is the empty-slot stub + normalizations + the CI check.What changed
.github/scripts/check_tutorials_complete.py+tutorials_complete.ymlCI — 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.tutorial_4_methods.pywas empty (0 bytes) since the bootstrap commit — never written, no source to restore. Filled with anot written yetstub matching the HowToLens stub convention (title + note +__Wrap Up__).tutorial_4_dealing_with_failure,tutorial_4_bayesian_regularization(both end on genuine prose conclusions),tutorial_searches(ends on a plot call).Scripts Changed
scripts/chapter_1_introduction/tutorial_4_methods.py— filled empty file with anot written yetstubscripts/chapter_2_modeling/tutorial_4_dealing_with_failure.py— add__Wrap Up__marker (already complete)scripts/chapter_4_pixelizations/tutorial_4_bayesian_regularization.py— add__Wrap Up__marker (already complete)scripts/chapter_optional/tutorial_searches.py— add__Wrap Up__section (already complete).github/scripts/check_tutorials_complete.py— new tutorial-completeness linter.github/workflows/tutorials_complete.yml— new CI workflow running the linternotebooks/**,llms-full.txt,workspace_index.json— regeneratedValidation checklist (--auto)
smoke_tests.txt4/4 (including the newtutorial_4_methodsstub), run on this branch.Part of the 3-repo rollout (HowToLens #27 → this → HowToFit). Does not close HowToLens#26.
🤖 Generated with Claude Code
https://claude.ai/code/session_01KExk2jkn2ya21b6NZLALpB