Skip to content

Commit 1a6f308

Browse files
committed
Recommend using intra-doc links on docs.rs immediately
1 parent 74df590 commit 1a6f308

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

posts/inside-rust/2020-09-11-stabilizing-intra-doc-links.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ pub struct S;
1616
pub fn f() {}
1717
```
1818

19+
Since [docs.rs](https://docs.rs) uses the latest nightly, intra-doc links are
20+
available to use today! Feel free to switch your libraries to use intra-doc
21+
links, which will fix broken links for re-exported types and links to different
22+
crates. We hope to add support for automating this process with [`cargo fix`]
23+
in the future.
24+
1925
## The history of intra-doc links
2026

2127
Intra-doc links have been around for a while, all the way back [since 2017][tracking-issue]!
@@ -215,3 +221,4 @@ In particular, there have been a ton of people who stepped up to help [convert t
215221
[primitive-module-ambiguity]: https://github.com/rust-lang/rust/pull/75815
216222
[remove-disambiguators]: https://github.com/rust-lang/rust/pull/76078
217223
[improve-suggestions]: https://github.com/rust-lang/rust/pull/75756
224+
[`cargo fix`]: https://github.com/rust-lang/rust/issues/75805

0 commit comments

Comments
 (0)