Skip to content

Commit 9c21bee

Browse files
authored
Merge pull request #1629 from ehuss/links-authoring
Authoring guide: clarify standard library linking
2 parents bad7ef1 + aba5e9d commit 9c21bee

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/authoring.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ This document serves as a guide for editors and reviewers. Some conventions and
1515
* Code blocks should have an explicit language tag.
1616
* Do not wrap long lines. This helps with reviewing diffs of the source.
1717
* 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.
18-
* Links should be relative with the `.md` extension. Links to other rust-lang books that are published with the reference or the standard library API should also be relative so that the linkchecker can validate them.
18+
* Links should be relative with the `.md` extension. Links to other rust-lang books that are published with the reference should also be relative so that the linkchecker can validate them.
19+
* Links to the standard library should use rustdoc-style links described in [Standard library links](#standard-library-links).
1920
* 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.
2021

2122
```markdown

0 commit comments

Comments
 (0)