Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extend intra-doc link chapter in the rustdoc book #121021

Merged
merged 1 commit into from
Feb 13, 2024
Merged

Extend intra-doc link chapter in the rustdoc book #121021

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,3 +151,21 @@ will be given, even if the link fails to resolve. For example, any link containi
characters will be ignored.

[#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]`.
Loading