Correct description of panic.rs

[felix91gr]

I was perusing the module documentation and stumbled upon the existing description, which confused me for a minute.

Summary:

The foremost description of this module was:

Panic support in the standard library.

This commit changes that to:

Panic support in core.

[rustbot]

r? @jhpratt

rustbot has assigned @jhpratt.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

• Owners of files modified in this PR: libs
• libs expanded to 7 candidates
• Random selection from Mark-Simulacrum, jhpratt

[jhpratt]

Can you elaborate about what in particular you found confusing about the current description?

[felix91gr]

Can you elaborate about what in particular you found confusing about the current description?

Of course :)

I was examining the panic module in core and I was greeted by this description:

I'm doing research and writing for safety critical rust. Since the distinction between std and core is extremely important in safety critical (like for e.g. https://rust-lang.zulipchat.com/#narrow/channel/122651-general/topic/How.20can.20I.20screw.20up.20my.20panic.20handler.3F/with/599176809), having the description of the module state "you are currently looking at std" when that's not true... made me wonder if I got lost and landed on a broken doc.

Dunno, the contradiction was a bit unsettling in that moment. I'm not the most seasoned rust dev by a long shot, so when the docs say something that contradicts my understanding of the language, I tend to assume I must be mistaken. This is not the case here, right? This should say "core" instead of "the standard library", right? I'm not 100% sure even right now.

[jhpratt]

Generally speaking, "standard library" refers to core, alloc, and std collectively, occasionally being extended to include proc_macro and test. So the documentation as-is is correct. With that said, I don't see any harm in explicitly saying core here.

@bors r+ rollup

[rust-bors]

📌 Commit f898e61 has been approved by jhpratt

It is now in the queue for this repository.

🌲 The tree is currently closed for pull requests below priority 5. This pull request will be tested once the tree is reopened.