Skip to content

Commit 665fac9

Browse files
committed
Rename Reflection section to Review; mark dedup_runs and quicksort as bonus
Rename the per-chapter 'Reflection' section (callout, slides, issue template, style/plan docs) to 'Review', tying it to the book's code-review framing. Also flag exercises 11 (dedup_runs) and 22 (quicksort) as optional bonus exercises across the book sidebar, chapter callouts, roadmap, and slides.
1 parent 7f22aa5 commit 665fac9

64 files changed

Lines changed: 105 additions & 89 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
name: Suggest a Reflection question
1+
name: Suggest a Review question
22
description: A question a thoughtful reviewer would ask on a chapter that we missed.
3-
title: "[reflection] ch. NN: <one-line summary>"
4-
labels: ["reflection", "book"]
3+
title: "[review] ch. NN: <one-line summary>"
4+
labels: ["review", "book"]
55
body:
66
- type: input
77
id: chapter
@@ -14,7 +14,7 @@ body:
1414
id: question
1515
attributes:
1616
label: Your suggested question
17-
description: Write it as you would in the Reflection callout.
17+
description: Write it as you would in the Review callout.
1818
validations:
1919
required: true
2020
- type: textarea

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ use the issue templates at
5353
`.github/ISSUE_TEMPLATE/` — they correspond to the kinds of feedback
5454
that genuinely help:
5555

56-
- **Suggest a Reflection question** — a question a thoughtful reviewer
56+
- **Suggest a Review question** — a question a thoughtful reviewer
5757
would ask on a chapter that we missed.
5858
- **Suggest a Trade-off** — an axis or consideration we didn't score.
5959
- **Suggest an Edge case** — production concerns that aren't covered.

TODO.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
66
---
77

8-
## 1. Put reflection prompts next to the source code (on a dedicated slide)
8+
## 1. Put review prompts next to the source code (on a dedicated slide)
99

1010
Each exercise should be a 3-slide sequence:
1111

1212
1. **Source code only** &mdash; the starter, full width.
13-
2. **Source code + reflection prompts side-by-side** &mdash; same starter on
14-
the left, reflection bullets on the right.
13+
2. **Source code + review prompts side-by-side** &mdash; same starter on
14+
the left, review bullets on the right.
1515
3. **Possible solution** &mdash; as today.
1616

1717
Use Slidev's `two-cols-header` layout for step 2:
@@ -36,11 +36,11 @@ pub fn describe(...) { ... }
3636
```
3737

3838
Notes:
39-
- Reflection bullets and the hint already render all-at-once (no
39+
- Review bullets and the hint already render all-at-once (no
4040
`v-clicks` animations).
4141
- Decide whether this applies to **every** exercise or only the ones
4242
where the starter is short enough to leave room on the right.
43-
- The current standalone `# NN · Reflection` slide goes away once
43+
- The current standalone `# NN · Review` slide goes away once
4444
the side-by-side version exists.
4545

4646
---

book/PLAN.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ sections** included only when there's something real to say.
6565
in real code.
6666
2. **Starter code**: `{{#include}}` from `examples/NN_*.rs`. Includes an
6767
inline "Try it yourself" callout with the `cargo` invocations.
68-
3. **Reflection**: the questions a thoughtful reviewer would ask, framed
68+
3. **Review**: the questions a thoughtful reviewer would ask, framed
6969
as prompts to the *reader*. (Renamed from "Observations", also update
7070
the slides under TODO item #1 in `TODO.md`.)
7171
4. **A possible solution**: the canonical solution from `solutions/`,
@@ -173,15 +173,15 @@ The book is physically incapable of shipping broken code.
173173

174174
**Senior-engineer-reviewing-with-you voice** (first-person plural for
175175
narration, first-person singular for contested opinions), with **light
176-
direct address** in Reflection and Follow-up sections.
176+
direct address** in Review and Follow-up sections.
177177

178178
Style rules (full version goes in `book/STYLE.md`):
179179

180180
- Default to **we** for narration ("we'd reach for `&str` here because…").
181181
- Use **I** sparingly, only for genuinely contested opinions
182182
("I'll admit I find `is_some_and` slightly noisier than
183183
`map_or(false, …)`, but…").
184-
- Use **you** only in Reflection prompts, Follow-up questions, and explicit
184+
- Use **you** only in Review prompts, Follow-up questions, and explicit
185185
instructions ("Try replacing the `Vec` with an iterator and see what
186186
breaks").
187187
- Never **the reader** / **one** / passive-voice avoidance of pronouns.
@@ -308,7 +308,7 @@ launch.
308308
chapters. **File an issue instead**, substantive suggestions are
309309
credited in Acknowledgements when adopted.
310310
- **Issue templates** in `.github/ISSUE_TEMPLATE/`:
311-
- Suggest a Reflection question
311+
- Suggest a Review question
312312
- Suggest a Trade-off I missed
313313
- Suggest an Edge case
314314
- Found a typo / bug
@@ -330,7 +330,7 @@ v1 scope:
330330
- Search on; sidebar on; prev/next on; stock playground button on `rust`
331331
blocks.
332332
- Blockquote-based callouts with a small CSS treatment to differentiate
333-
the 7-section spine labels (`EXERCISE`, `REFLECTION`, `TRY THIS`,
333+
the 7-section spine labels (`EXERCISE`, `REVIEW`, `TRY THIS`,
334334
`TRADE-OFF`, `EDGE CASE`, `FOLLOW-UP`, `CONCEPT`).
335335
- Light + dark only; kill the other three default themes (coal, ayu,
336336
rust) unless that creates friction.
@@ -408,7 +408,7 @@ written by copying their shape. No separate format spec document.
408408
- `STYLE.md` skeleton (extended through Phase 2).
409409
- `CONTRIBUTING.md` + issue templates.
410410
- `LICENSE` (root) + `book/LICENSE.md`.
411-
- Rename "Observations" → "Reflection" in `slides/pages/*.md` (TODO item
411+
- Rename "Observations" → "Review" in `slides/pages/*.md` (TODO item
412412
#1 in the existing `TODO.md`).
413413

414414
### Phase 1, Thesis (~3 days)

book/STYLE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*"I'll admit I find `is_some_and` slightly noisier than
1515
`map_or(false, …)`, but the predicate reads in order of evaluation."*
1616
- **Use "you"** in:
17-
- *Reflection* prompts
17+
- *Review* prompts
1818
- *Follow-up questions*
1919
- explicit instructions ("Try replacing the `Vec` with an iterator
2020
and see what breaks")
@@ -70,7 +70,7 @@ Every chapter follows the 7-section spine from `PLAN.md` §3:
7070

7171
1. The problem
7272
2. Starter code
73-
3. Reflection
73+
3. Review
7474
4. A possible solution
7575
5. Trade-offs (six fixed axes; same order every time)
7676
6. Quiz
@@ -90,7 +90,7 @@ The CSS in `theme/css/corrode.css` styles the leading `**LABEL**` as a
9090
small-caps badge.
9191

9292
```markdown
93-
> **REFLECTION**
93+
> **REVIEW**
9494
>
9595
> - Does the function need to own the string?
9696
> - What does `chars().nth(0)` do, and is there a more direct way?
@@ -99,7 +99,7 @@ small-caps badge.
9999
Standard labels:
100100

101101
- `EXERCISE`: wraps the starter listing
102-
- `REFLECTION`: the questions a thoughtful reviewer would ask
102+
- `REVIEW`: the questions a thoughtful reviewer would ask
103103
- `TRY THIS`: an inline call to action
104104
- `TRADE-OFF`: the per-chapter scoring section
105105
- `EDGE CASE`: production concerns

book/src/SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
# Part III. Aggregations & counting
3030

3131
- [Overview](part-3-aggregations/README.md)
32-
- [11 · dedup_runs](part-3-aggregations/11-dedup-runs.md)
32+
- [11 · dedup_runs (bonus)](part-3-aggregations/11-dedup-runs.md)
3333
- [12 · excluded_path](part-3-aggregations/12-excluded-path.md)
3434
- [13 · spell_check](part-3-aggregations/13-spell-check.md)
3535
- [14 · room_occupancy](part-3-aggregations/14-room-occupancy.md)
@@ -44,7 +44,7 @@
4444
- [19 · iterators](part-4-strings-parsing/19-iterators.md)
4545
- [20 · transformer](part-4-strings-parsing/20-transformer.md)
4646
- [21 · fun_strings_ext](part-4-strings-parsing/21-fun-strings-ext.md)
47-
- [22 · quicksort](part-4-strings-parsing/22-quicksort.md)
47+
- [22 · quicksort (bonus)](part-4-strings-parsing/22-quicksort.md)
4848

4949
# Part V. Domain modeling
5050

book/src/how-to-use.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ default mode. For each chapter:
1515
3. **Stop reading the chapter.** Make a list of what you'd say in a
1616
review. Try to refactor the code yourself in your editor. Spend
1717
five to twenty minutes, depending on the chapter's size.
18-
4. Then read *Reflection* and see which of your observations match
18+
4. Then read *Review* and see which of your observations match
1919
ours, and which we surfaced that you didn't.
2020
5. Read *A possible solution* and compare it to yours.
2121
6. Read *Trade-offs* and decide whether you agree with our scoring.
@@ -31,8 +31,8 @@ them. A little trick is to delete your first attempt at the refactor before tryi
3131
## Pair
3232

3333
Two engineers, one keyboard. One drives (writes the refactor), one
34-
reviews (asks the *Reflection* questions out loud, gently). Swap roles
35-
every chapter, or every other chapter. The chapter's *Reflection*
34+
reviews (asks the *Review* questions out loud, gently). Swap roles
35+
every chapter, or every other chapter. The chapter's *Review*
3636
section gives the reviewer their script, but the best discussions
3737
happen when the reviewer goes off-script.
3838

@@ -45,7 +45,7 @@ A small group, three to eight people, reads one chapter per week.
4545
Anyone who wants to brings their refactored version. The meeting (an
4646
hour, max) walks through:
4747

48-
1. What each person noticed in *Reflection* before reading ours.
48+
1. What each person noticed in *Review* before reading ours.
4949
2. Whose solution is closest to the canonical, whose is furthest, why.
5050
3. Where the group disagrees with the *Trade-offs* scoring.
5151
4. The *Follow-up questions*. These were chosen for exactly this
@@ -61,7 +61,7 @@ if your team is past them.
6161
If you're running an internal workshop, the slides in `slides/`
6262
(<https://github.com/corrode/refactoring>) are the live-delivery
6363
artifact and the book is your reference companion. Use the chapter's
64-
*Reflection* questions as your prompts to the room; use *Trade-offs*
64+
*Review* questions as your prompts to the room; use *Trade-offs*
6565
to keep the discussion honest when it veers into religion; use
6666
*Follow-up questions* as the breakout-room material.
6767

@@ -118,7 +118,7 @@ labelled block:
118118
>
119119
> Wraps the starter listing. *"Here's what you're refactoring."*
120120
121-
> **REFLECTION**
121+
> **REVIEW**
122122
>
123123
> The questions a thoughtful reviewer would ask. The book's signature
124124
> section.
@@ -144,6 +144,10 @@ labelled block:
144144
> [Cheatsheet](appendix/concept-index.md) entry where it's defined
145145
> properly and linked from every other chapter that touches it.
146146
147+
A few chapters open with a **BONUS** callout. Those are optional: skip
148+
them if you're short on time, since nothing later in the book depends
149+
on them.
150+
147151
## Filing issues
148152

149153
If you spot a typo, a broken link, a refactor we missed, or a

book/src/part-1-warmups/01-starts-with-uppercase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
>
77
> 1. The problem
88
> 2. Starter code (`{{#include}}` from `examples/`)
9-
> 3. Reflection
9+
> 3. Review
1010
> 4. A possible solution
1111
> 5. Trade-offs (six axes)
1212
> 6. Quiz (after Trade-offs, before Follow-ups)

book/src/part-1-warmups/02-better-match.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
>
77
> 1. The problem
88
> 2. Starter code (`{{#include}}` from `examples/`)
9-
> 3. Reflection
9+
> 3. Review
1010
> 4. A possible solution
1111
> 5. Trade-offs (six axes)
1212
> 6. Quiz (after Trade-offs, before Follow-ups)

book/src/part-1-warmups/03-even-numbers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
>
77
> 1. The problem
88
> 2. Starter code (`{{#include}}` from `examples/`)
9-
> 3. Reflection
9+
> 3. Review
1010
> 4. A possible solution
1111
> 5. Trade-offs (six axes)
1212
> 6. Quiz (after Trade-offs, before Follow-ups)

0 commit comments

Comments
 (0)