mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Extend intra-doc link chapter in the rustdoc book

Browse Source
This commit is contained in:
Guillaume Gomez 2024-02-13 11:46:28 +01:00
parent d6c46a23ce
commit 1392f60dfd
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md
View File

@ -151,3 +151,21 @@ will be given, even if the link fails to resolve. For example, any link containi
characters will be ignored. characters will be ignored.
[#72243]: https://github.com/rust-lang/rust/issues/72243 [#72243]: https://github.com/rust-lang/rust/issues/72243
## What happens in case an intra-doc link cannot be generated
In some cases (items behind a `cfg` for example), an intra-doc link cannot be generated to item.
There are different ways to create a link in markdown, and depending on the one you use, it will
render differently in this case:
```md
1. [a]
2. [b][c]
3. [d](e)
4. [f]
[f]: g
```
`1.` and `2.` will will be displayed as is in the rendered documentation (ie, `[a]` and `[b][c]`)
whereas `3.` and `4.` will be replaced by a link targetting `e` for `[d](e)` and `g` for `[f]`.