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: reference-dev-guide/src/formatting/markdown.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,27 +5,27 @@ There are automated checks for some of these rules. Run [`cargo xtask style-chec
5
5
## Formatting style
6
6
7
7
- Use [ATX-style headings][atx] (not Setext) with [sentence case].
8
-
- Do not use tabs, only spaces.
8
+
- Do not use tabs; use only spaces.
9
9
- Files must end with a newline.
10
-
- Lines must not end with spaces. Double spaces have semantic meaning, but can be invisible. Use a trailing backslash if you need a hard line break.
10
+
- Lines must not end with spaces. Double spaces have semantic meaning but can be invisible. Use a trailing backslash if you need a hard line break.
11
11
- If possible, avoid double blank lines.
12
12
- Do not wrap long lines. This helps with reviewing diffs of the source.
13
-
- Use [smart punctuation] instead of Unicode characters. For example, use `---` for em-dash instead of the Unicode character. Characters like em-dash can be difficult to see in a fixed-width editor, and some editors may not have easy methods to enter such characters.
13
+
- Use [smart punctuation] instead of Unicode characters. For example, use `---` for an em-dash instead of the Unicode character. Characters like the em-dash can be difficult to see in a fixed-width editor, and some editors may not have easy methods to enter such characters.
14
14
- See the [admonitions chapter] for formatting callouts such as notes, edition differences, and warnings.
15
15
16
16
## Code blocks
17
17
18
-
- Do not use indented code blocks; use 3+ backticks code blocks instead.
18
+
- Do not use indented code blocks; use fenced code blocks with 3+ backticks instead.
19
19
- Code blocks should have an explicit language tag.
20
20
21
21
## Links
22
22
23
23
See the [links chapter] for more information about linking.
24
24
25
-
- Links to other chapters should be relative with the `.md` extension.
25
+
- Links to other chapters should be relative and use the `.md` extension.
26
26
- Links to other rust-lang books that are published with the Reference should also be relative so that the linkchecker can validate them. See [outside book links].
27
-
- Links to the standard library should use rustdoc-style links described in [standard library links].
28
-
- The use of reference links is preferred, with shortcuts if appropriate. Place the sorted link reference definitions at the bottom of the file or at the bottom of a section if there are an unusually large number of links that are specific to the section.
27
+
- Links to the standard library should use rustdoc-style links as described in [standard library links].
28
+
- The use of reference links is preferred, with shortcuts if appropriate. Place sorted link reference definitions at the bottom of the file, or at the bottom of a section if there is an unusually large number of links specific to that section.
0 commit comments