Skip to content

Commit f72f09f

Browse files
committed
Recommend this for _stable_ users, not just for docs.rs
1 parent 1a6f308 commit f72f09f

File tree

1 file changed

+1
-7
lines changed

1 file changed

+1
-7
lines changed

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,10 @@ 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.
19+
Intra-doc links have been around for a while, all the way back [since 2017][tracking-issue]! What changed recently is that they will be available on `stable` starting with Rust 1.48.0. We recommend that you switch your libraries to use intra-doc links, which will fix broken links for re-exported types and links to different crates. We hope to add support for automating this process with [`cargo fix`] in the future.
2420

2521
## The history of intra-doc links
2622

27-
Intra-doc links have been around for a while, all the way back [since 2017][tracking-issue]!
28-
2923
I (Manish) and [QuietMisdreavus](https://github.com/QuietMisdreavus) started working on them in December 2017. Mozilla had given the whole company a couple weeks off after the release of [Firefox Quantum](https://blog.mozilla.org/blog/2017/11/14/introducing-firefox-quantum/), and I was visiting family in Mumbai. This meant that I had a fair amount of free time, and we were in diametrically opposite timezones. QuietMisdreavus had been working on the feature for a while but was less familiar with rustc's path resolution code, so I decided to help. We ended up pairing for those few weeks: during the day I'd write some code, discuss with QuietMisdreavus in the evening, and then hand it over for her to continue overnight. It was a great experience, pairing in open source can be really fun! This ended up in a [46-commit pull request][intra-pr] with commits from both of us.
3024

3125

0 commit comments

Comments
 (0)