Skip to content

Correct description of panic.rs#157254

Open
felix91gr wants to merge 1 commit into
rust-lang:mainfrom
felix91gr:patch-1
Open

Correct description of panic.rs#157254
felix91gr wants to merge 1 commit into
rust-lang:mainfrom
felix91gr:patch-1

Conversation

@felix91gr
Copy link
Copy Markdown
Contributor

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.

The foremost description of this module was:
> Panic support in the standard library.
This commit changes that to:
> Panic support in core.
@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jun 1, 2026
@rustbot
Copy link
Copy Markdown
Collaborator

rustbot commented Jun 1, 2026

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
Copy link
Copy Markdown
Member

jhpratt commented Jun 2, 2026

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

@felix91gr
Copy link
Copy Markdown
Contributor Author

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:

A screenshot of the landing page at the `core::panic` docs. It shows, from top to bottom: (1) the browser's address bar at https://doc.rust-lang.org/core/panic/, (2) the name of the module (core), (3) the description and MSRV: 'Module panic; Since 1.41.0', and finally the description: 'Panic support in the standard library.'

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants