You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: text/3503-frontmatter.md
+7-2Lines changed: 7 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,11 @@ fn main() {
30
30
}
31
31
````
32
32
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
+
33
38
# Motivation
34
39
[motivation]: #motivation
35
40
@@ -97,7 +102,7 @@ the responsibility for high quality error messages will largely fall on cargo.
97
102
98
103
- A new concept for Rust syntax, adding to overall cognitive load
99
104
- 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)**
- In the future, this can be leveraged by other build systems or tools
183
188
184
189
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)**
186
191
- Maintainers seeding GitHub issue templates with 4 backticks can help
187
192
- Familiar syntax in an unfamiliar use may make users feel unsettled, unsure how to proceed (what works and what doesn't).
188
193
- If viewed from the lens of a comment, it isn't a variant of comment syntax like doc-comments
0 commit comments