mirror of
https://github.com/rust-lang/rust.git
synced 2025-01-13 00:04:12 +00:00
689978c176
Improve links in inline code in `core::pin`. ## Context So I recently opened #80720. That PR uses HTML-based `<code>foo</code>` syntax in place of `` `foo` `` for some inline code. It looks like usage of `<code>` tags in doc comments is without precedent in the standard library, but the HTML-based syntax has an important advantage: You can write something like ``` <code>[Box]<[Option]\<T>></code> ``` which becomes: <code>[Box]<[Option]\<T>></code>, whereas with ordinary backtick syntax, you cannot create links for a substring of an inline code block. ## Problem I recalled (from my own experience) that a way to partially work around this limitation is to do something like ``` [`Box`]`<`[`Option`]`<T>>` ``` which looks like this: [`Box`]`<`[`Option`]`<T>>` _(admitted, it looks even worse on GitHub than in `rustdoc`’s CSS)_. [Box]: https://doc.rust-lang.org/std/boxed/struct.Box.html "Box" [`Box`]: https://doc.rust-lang.org/std/boxed/struct.Box.html "Box" [Option]: https://doc.rust-lang.org/std/option/enum.Option.html "Option" [`Option`]: https://doc.rust-lang.org/std/option/enum.Option.html "Option" [Pin]: https://doc.rust-lang.org/std/pin/struct.Pin.html "Pin" [&mut]: https://doc.rust-lang.org/std/primitive.reference.html "mutable reference" So I searched the standard library and found that e.g. the [std::pin](https://doc.rust-lang.org/std/pin/index.html) module documentation uses this hack/workaround quite a bit, with types like <code>[Pin]<[Box]\<T>></code> or <code>[Pin]<[&mut] T>></code>. Although the way they look like in this sentence is what I would like them to look like, not what they currently look. ### Status Quo Here’s a screenshot of what it currently looks like:  With a few HTML-style code blocks, we can fix all the spacing issues in the above screenshot that are due usage of this hack/workaround of putting multiple code blocks right next to each other being used. ### after |
||
|---|---|---|
| .. | ||
| alloc | ||
| array | ||
| char | ||
| convert | ||
| fmt | ||
| future | ||
| hash | ||
| iter | ||
| macros | ||
| mem | ||
| num | ||
| ops | ||
| prelude | ||
| ptr | ||
| slice | ||
| str | ||
| stream | ||
| sync | ||
| task | ||
| unicode | ||
| any.rs | ||
| ascii.rs | ||
| bool.rs | ||
| borrow.rs | ||
| cell.rs | ||
| clone.rs | ||
| cmp.rs | ||
| default.rs | ||
| ffi.rs | ||
| hint.rs | ||
| internal_macros.rs | ||
| intrinsics.rs | ||
| lazy.rs | ||
| lib.rs | ||
| marker.rs | ||
| option.rs | ||
| panic.rs | ||
| panicking.rs | ||
| pin.rs | ||
| primitive.rs | ||
| raw.rs | ||
| result.rs | ||
| time.rs | ||
| tuple.rs | ||
| unit.rs | ||
