From af8442a863fe3984828d4d052794c9aea24e0c17 Mon Sep 17 00:00:00 2001 From: ytwei Date: Wed, 26 Aug 2026 21:33:41 +0800 Subject: [PATCH] docs: clarify automatic checks in built-in editor --- docs-site/how-it-works.md | 4 ++-- docs-site/index.md | 5 +++-- docs-site/quick-start.md | 8 +++++--- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs-site/how-it-works.md b/docs-site/how-it-works.md index 6018f85..fd8543b 100644 --- a/docs-site/how-it-works.md +++ b/docs-site/how-it-works.md @@ -9,8 +9,8 @@ Pythonlings follows a tight edit-check-advance loop. Here is what happens at eac ## The Learner Loop 1. **Open the next pending exercise** — the TUI shows the first incomplete exercise in the curriculum. -2. **Edit the broken code** — fix the intentional mistake directly in the built-in editor (or any external editor you prefer). -3. **Checks rerun automatically** — roughly 0.6 s after you stop typing, Pythonlings re-evaluates the exercise in a fresh subprocess. There is no filesystem watcher; the debounce fires inside the TUI editor. +2. **Edit the broken code** — fix the intentional mistake directly in the built-in editor. This is the automatic edit-check-advance workflow. If you use an external editor, save the file and run `pythonlings run ` to check it manually. +3. **Checks rerun automatically** — roughly 0.6 s after you stop typing in the built-in editor, Pythonlings re-evaluates the exercise in a fresh subprocess. There is no filesystem watcher, so external saves do not trigger this automatic check. 4. **Remove the `# I AM NOT DONE` marker** — the marker is your explicit "I'm finished" signal. Passing checks alone does not advance the exercise (see below). 5. **Advance** — once checks are green *and* the marker is gone, the exercise is marked complete and the TUI moves to the next one. diff --git a/docs-site/index.md b/docs-site/index.md index 4dfe3df..935f63d 100644 --- a/docs-site/index.md +++ b/docs-site/index.md @@ -7,8 +7,9 @@ hide:
Rustlings for Python
Learn Python by fixing tiny broken programs.
-
292 exercises across 31 topics. Hidden checks rerun the - instant you save — fix the code, watch it go green, advance.
+
292 exercises across 31 topics. In the built-in editor, + hidden checks rerun after you stop typing — fix the code, watch it go green, + advance.
$ uvx pythonlings init
Get started → diff --git a/docs-site/quick-start.md b/docs-site/quick-start.md index ddcea0a..c549e4a 100644 --- a/docs-site/quick-start.md +++ b/docs-site/quick-start.md @@ -61,6 +61,8 @@ pythonlings update # pull new exercises into an existing workspace ## Exercise Loop Each exercise contains a `# I AM NOT DONE` marker. Open the file in the TUI -editor (or any editor), fix the broken code, then remove the marker. Pythonlings -runs the hidden check automatically; when the check passes and the marker is gone, -the exercise is marked complete and progress advances to the next one. +editor and fix the broken code, then remove the marker. The built-in editor runs +the hidden check automatically; if you use an external editor, save the file and +run `pythonlings run ` to check it manually. When the check passes and the +marker is gone in the TUI, the exercise is marked complete and progress advances +to the next one.