]> git.lizzy.rs Git - rust.git/commit - src/tools/miri
Auto merge of #88343 - steffahn:fix_code_spacing, r=jyn514
authorbors <bors@rust-lang.org>
Sat, 25 Sep 2021 20:08:11 +0000 (20:08 +0000)
committerbors <bors@rust-lang.org>
Sat, 25 Sep 2021 20:08:11 +0000 (20:08 +0000)
commitaddb4da686a97da46159f0123cb6cdc2ce3d7fdb
treee7e29d87736398b7d7c7884b7ec17552c770a243
parent9620f3a84b079decfdc2e557be007580b097fe43
parent67065fe93366cfdd9e88440b6f876c3dfeb1f937
Auto merge of #88343 - steffahn:fix_code_spacing, r=jyn514

Fix spacing of links in inline code.

Similar to #80733, but the focus is different. This PR eliminates all occurrences of pieced-together inline code blocks like [`Box`]`<`[`Option`]`<T>>` and replaces them with good-looking ones (using HTML-syntax), like <code>[Box]<[Option]\<T>></code>. As far as I can tell, I should’ve found all of these in the standard library (regex search with `` r"`\]`|`\[`" ``) \[except for in `core::convert` where I’ve noticed other things in the docs that I want to fix in a separate PR]. In particular, unlike #80733, I’ve added almost no new instance of inline code that’s broken up into multiple links (or some link and some link-free part). I also added tooltips (the stuff in quotes for the markdown link listings) in places that caught my eye, but that’s by no means systematic, just opportunistic.

[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"

Context: I got annoyed by repeatedly running into new misformatted inline code while reading the standard library docs. I know that once issue #83997 (and/or related ones) are resolved, these changes become somewhat obsolete, but I fail to notice much progress on that end right now.

r? `@jyn514`
library/alloc/src/vec/mod.rs
library/core/src/iter/mod.rs
library/core/src/iter/traits/iterator.rs
library/core/src/option.rs
library/std/src/collections/mod.rs
library/std/src/ffi/c_str.rs
library/std/src/io/mod.rs
library/std/src/time.rs