Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs-site/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <name>` 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.

Expand Down
5 changes: 3 additions & 2 deletions docs-site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ hide:
<div class="pl-hero" markdown>
<div class="pl-eyebrow">Rustlings for Python</div>
<div class="pl-title">Learn Python by fixing tiny broken programs.</div>
<div class="pl-subtitle">292 exercises across 31 topics. Hidden checks rerun the
instant you save — fix the code, watch it go green, advance.</div>
<div class="pl-subtitle">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.</div>
<div class="pl-install">$ uvx pythonlings init</div>
<div class="pl-ctas">
<a class="pl-btn" href="quick-start/">Get started →</a>
Expand Down
8 changes: 5 additions & 3 deletions docs-site/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <name>` 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.
Loading