From 2b2722fa20be55871c42f37441ac5cb92ab6275b Mon Sep 17 00:00:00 2001 From: daxpedda Date: Wed, 25 Oct 2023 19:16:17 +0200 Subject: [PATCH] Prefer full reference links for intra-doc links --- .../src/write-documentation/linking-to-items-by-name.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md b/src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md index 72157b5cd9bce..aa0e5a782893e 100644 --- a/src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md +++ b/src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md @@ -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] @@ -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`. The link will -resolve as if you had written ``[`Vec`](Vec)``. Fully-qualified syntax (for example, +resolve as if you had written ``[`Vec`][Vec]``. Fully-qualified syntax (for example, `::into_iter()`) is [not yet supported][fqs-issue], however. [fqs-issue]: https://github.com/rust-lang/rust/issues/74563 @@ -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() {}