Repository navigation
Tutorial notebooks: fix spelling, headings, stale content and grammar - #814
Merged
milton-minervino merged 4 commits intoOct 29, 2026
Merged
Conversation
milton-minervino
requested review from
guerinclement and
guillaume-vignal
and removed request for
guillaume-vignal
October 23, 2026 10:04
milton-minervino
marked this pull request as ready for review
October 23, 2026 10:04
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #814 +/- ##
========================================
Coverage 86.08% 86.08%
========================================
Files 115 115
Lines 11825 11825
Branches 2158 2158
========================================
Hits 10180 10180
Misses 1009 1009
Partials 636 636 🚀 New features to boost your workflow:
|
Heading levels no longer skip, so the myst.header warning no longer needs to be suppressed in the docs build.
Replace references to the removed acv backend, align intros and contents lists with what the notebooks do, point webapp launch examples to the scripts folder and use app.run, as Dash 3 removed app.run_server.
Use short descriptive headings instead of instructions, fix the wording of bare step labels, and drop redundant prefixes from notebook titles.
Rewrite ungrammatical sentences in the older tutorials without changing their meaning, and clean up the intro openers and contents lists.
milton-minervino
force-pushed
the
docs/tutorial-rewrite
branch
from
October 29, 2026 15:21
5cd1f23 to
85bbbd9
Compare
guillaume-vignal
approved these changes
Oct 29, 2026
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.
Why
#809 listed a review of the notebook titles and headings as a follow-up. Many tutorials, mostly the older ones, also had spelling mistakes, headings that skipped levels, leftover HTML, outdated references and ungrammatical sentences. Since the notebooks are now part of the docs site, these show up directly in the docs.
What changed
Four commits, one per kind of change:
Spelling, heading levels and HTML (22 notebooks)
##→####), and each notebook has a single H1. Themyst.headerwarning suppression is removed fromdocs/conf.py.<br />and<b>with Markdown.Stale content (14 notebooks)
scripts/webapp_launch_*.py, which moved in refactor: move examples of webapp launch into scripts #779. The commented examples now useapp.run, since Dash 3 removedapp.run_server.Titles and headings (23 notebooks)
scatter_plot_predictionandlift_curve_plot", "Usingcategory_encoders").Grammar (22 notebooks)
Apart from the two
run_servercomments, only markdown cells change: no code, outputs or cell IDs. Filenames are unchanged, so tutorial URLs stay the same.How to test
The build passes with
-Wand no warnings, including without themyst.headersuppression.