Skip to content

Commit 1b860d4

Browse files
committed
feat: Make sure people know what they are signing up for
1 parent 9f2aec2 commit 1b860d4

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

text/3503-frontmatter.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ fn main() {
3030
}
3131
````
3232

33+
Note that to share these in markdown, a priority use case, extra backticks for the markdown code fence to escape the frontmatter code fence.
34+
We expect most users will not be familiar enough with the markdown spec to know this, especially one of our primary target audience: those new to Rust.
35+
This can also be frustrating for experienced users as three backticks is an ingrained habbit and it is common to need to go back and edit a post to properly escape the frontmatter.
36+
However, when weighing out the syntactic needs and the alternatives, we felt this was the least bad option.
37+
3338
# Motivation
3439
[motivation]: #motivation
3540

@@ -97,7 +102,7 @@ the responsibility for high quality error messages will largely fall on cargo.
97102

98103
- A new concept for Rust syntax, adding to overall cognitive load
99104
- Ecosystem tooling updates to deal with new syntax
100-
- When sharing in markdown documents (e.g. GitHub issues), requires people escape markdown code fences with an extra backtick which they are likely not used to doing (or aware even exists)
105+
- **When sharing in markdown documents (e.g. GitHub issues), requires people escape markdown code fences with an extra backtick which they are likely not used to doing (or aware even exists)**
101106

102107
# Rationale and alternatives
103108
[rationale-and-alternatives]: #rationale-and-alternatives
@@ -182,7 +187,7 @@ Benefits:
182187
- In the future, this can be leveraged by other build systems or tools
183188

184189
Downsides:
185-
- When sharing in markdown documents (e.g. GitHub issues), requires people escape markdown code fences with an extra backtick which they are likely not used to doing (or aware even exists)
190+
- **When sharing in markdown documents (e.g. GitHub issues), requires people escape markdown code fences with an extra backtick which they are likely not used to doing (or aware even exists)**
186191
- Maintainers seeding GitHub issue templates with 4 backticks can help
187192
- Familiar syntax in an unfamiliar use may make users feel unsettled, unsure how to proceed (what works and what doesn't).
188193
- If viewed from the lens of a comment, it isn't a variant of comment syntax like doc-comments

0 commit comments

Comments
 (0)