Use intra-doc links in core::macros

[camelid]

Part of #75080.

Also cleaned up some things.

@rustbot modify labels: A-intra-doc-links T-doc T-rustdoc

[rust-highfive]

r? @cramertj

(rust_highfive has picked a reviewer for you, use r? to override)

[camelid]

NOTE: the intra-doc links in panic.md must be checked by hand before this is merged. I'll need to get my local build going :)

From @jyn514:

If you can get rustdoc to create the links for markdown files, I think it's fine to convert them too, but I'd want to make sure the pass is actually being run and the links aren't silently being ignored.

[jyn514]

I decided that T-rustdoc isn't very helpful for these - the other labels are still great though :)
#75917 (comment)

[camelid]

Makes sense to me :)

[jyn514]

This uses doc(include = "panic.md"), so it should work fine when included. I'm all for verifying that though :)

rust/library/core/src/macros/mod.rs

Line 1 in bf43421

#[doc(include = "panic.md")]

[camelid]

Hmm, why is this happening?

 error: `[format]` cannot be resolved, ignoring it.
 --> library/core/src/macros/mod.rs:1:1
  |
1 | #[doc(include = "panic.md")]
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  |
  = note: `-D intra-doc-link-resolution-failure` implied by `-D warnings`
  = note: the link appears in this line:
          
          [`format!`] syntax for building a string.
           ^^^^^^^^^
  = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

error: `[format]` cannot be resolved, ignoring it.
   --> library/core/src/macros/mod.rs:729:39
    |
729 |     /// All other formatting macros ([`format!`], [`write!`], [`println!`], etc) are
    |                                       ^^^^^^^^^ cannot be resolved, ignoring
    |
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

 error: `[println]` cannot be resolved, ignoring it.
   --> library/core/src/macros/mod.rs:729:64
    |
729 |     /// All other formatting macros ([`format!`], [`write!`], [`println!`], etc) are
    |                                                                ^^^^^^^^^^ cannot be resolved, ignoring
    |
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

error: aborting due to 3 previous errors

[jyn514]

format is in alloc, because it allocates: https://doc.rust-lang.org/src/alloc/macros.rs.html#105-110. println is std-only because it does IO: https://doc.rust-lang.org/src/std/macros.rs.html#94-99

[jyn514]

r=me with nit addressed and CI passing

[jyn514]

error: `[Box]` cannot be resolved, ignoring it.
error: `[Any]` cannot be resolved, ignoring it.
error: `[format]` cannot be resolved, ignoring it.

Oops, my fault, sorry.

[camelid]

Do I have to use a non-intra-doc link for Box since it requires allocation?

[jyn514]

Do I have to use a non-intra-doc link for Box since it requires allocation?

Yes, Any is in core though: https://doc.rust-lang.org/core/any/trait.Any.html

[camelid]

That's what I thought. Should be all done now!

[jyn514]

Do you mind squashing the commits?

[camelid]

Squashed! :)

[jyn514]

@bors r+ rollup

Finally good to go 😆

[bors]

📌 Commit 511ee05 has been approved by jyn514

[pickfire]

Why not just make the original version Option::unwrap and Result::unwrap by tweaking the text a bit?

[jyn514]

Let's make that a follow-up PR, this one's been through enough 😆

[pickfire]

I forgot my the last time I commented on a PR that needs a follow up PR, I wanted to go back to that but I forgot which PR is it.

[jyn514]

Try one of these: https://github.com/rust-lang/rust/pulls?q=is%3Apr+reviewed-by%3Apickfire+label%3AT-doc+is%3Aclosed+label%3AA-intra-doc-links

[pickfire]

@pickfire clean up text when this is merged.