Skip to content

Commit e774818

Browse files
committed
Rewrite frontmatter intro sentence
The intro under `r[frontmatter.intro]` said "an optional section for content intended for external tools without requiring these tools to have full knowledge of the Rust grammar." This was structurally ambiguous -- "without requiring" dangled between modifying "content" and the whole clause -- and it led with a negative construction (what frontmatter doesn't require) rather than a positive one (what it is and what it enables). In this commit, we rewrite the intro as "an optional section of metadata whose syntax allows external tools to read it without parsing Rust." This tells the reader three things in one sentence: what frontmatter is, who it's for, and the key design property.
1 parent d4431d4 commit e774818

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/frontmatter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ INFOSTRING -> (XID_Start | `_`) ( XID_Continue | `-` | `.` )*
3535
```
3636

3737
r[frontmatter.intro]
38-
Frontmatter is an optional section for content intended for external tools without requiring these tools to have full knowledge of the Rust grammar.
38+
Frontmatter is an optional section of metadata whose syntax allows external tools to read it without parsing Rust.
3939

4040
> [!EXAMPLE]
4141
> <!-- ignore: test runner doesn't support frontmatter -->

0 commit comments

Comments
 (0)