Skip to content

Commit becd39b

Browse files
committed
Apply some light edits to the markdown chapter
1 parent 661f2dc commit becd39b

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

reference-dev-guide/src/formatting/markdown.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ There are automated checks for some of these rules. Run [`cargo xtask style-chec
55
## Formatting style
66

77
- 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.
99
- 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.
1111
- If possible, avoid double blank lines.
1212
- 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.
1414
- See the [admonitions chapter] for formatting callouts such as notes, edition differences, and warnings.
1515

1616
## Code blocks
1717

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.
1919
- Code blocks should have an explicit language tag.
2020

2121
## Links
2222

2323
See the [links chapter] for more information about linking.
2424

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.
2626
- 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.
2929

3030
```markdown
3131
Example of shortcut link: [enumerations]

0 commit comments

Comments
 (0)