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

Prefer full reference links for intra-doc links #117178

Closed
wants to merge 1 commit into from
Closed

Prefer full reference links for intra-doc links #117178

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
8 changes: 4 additions & 4 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 @@ -9,7 +9,7 @@ For example, in the following code all of the links will link to the rustdoc pag
/// This struct is not [Bar]
pub struct Foo1;

/// This struct is also not [bar](Bar)
/// This struct is also not [bar][Bar]
pub struct Foo2;

/// This struct is also not [bar][b]
Expand Down Expand Up @@ -40,7 +40,7 @@ trait implementations][#79682]. Rustdoc also supports linking to all primitives
[#79682]: https://github.com/rust-lang/rust/pull/79682

You can also refer to items with generic parameters like `Vec<T>`. The link will
resolve as if you had written ``[`Vec<T>`](Vec)``. Fully-qualified syntax (for example,
resolve as if you had written ``[`Vec<T>`][Vec]``. Fully-qualified syntax (for example,
`<Vec as IntoIterator>::into_iter()`) is [not yet supported][fqs-issue], however.

[fqs-issue]: https://github.com/rust-lang/rust/issues/74563
Expand Down Expand Up @@ -78,10 +78,10 @@ their namespace, but can overlap with items in other namespaces. In case of ambi
rustdoc will warn about the ambiguity and suggest a disambiguator.

```rust
/// See also: [`Foo`](struct@Foo)
/// See also: [`Foo`][struct@Foo]
struct Bar;

/// This is different from [`Foo`](fn@Foo)
/// This is different from [`Foo`][fn@Foo]
struct Foo {}

fn Foo() {}
Expand Down
Loading