Skip to content

Commit 87741e9

Browse files
testac974claude
andcommitted
Fix markdownlint errors in Digestible Interfaces chapter
- Update MD024 config to use siblings_only (allows repeated subheadings under different parent headings) - Add 'text' language specifier to error message code blocks Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 4b8dc36 commit 87741e9

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

.markdownlint.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"MD003": { "style": "atx" },
55
"MD007": { "indent": 2 },
66
"MD013": false,
7-
"MD024": { "allow_different_nesting": true },
7+
"MD024": { "siblings_only": true },
88
"MD025": false,
99
"MD033": { "allowed_elements": ["br", "details", "summary"] },
1010
"MD041": false,

book/part1-foundations/04-digestible-interfaces/08-measuring-digestibility.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ If the answer is "probably not," the interface needs to be more explicit.
248248

249249
**Example prompt**:
250250

251-
```
251+
```text
252252
Given this function signature, write code that creates a user:
253253
254254
def create_user(request: CreateUserRequest) -> User:
@@ -298,15 +298,15 @@ Error messages should answer:
298298

299299
**Good error**:
300300

301-
```
301+
```text
302302
ValidationError: CreateUserRequest.password must be at least 8 characters.
303303
Received: "abc" (3 characters)
304304
Fix: Provide a password with 8 or more characters.
305305
```
306306

307307
**Bad error**:
308308

309-
```
309+
```text
310310
ValueError: Invalid input
311311
```
312312

0 commit comments

Comments
 (0)