update panicking() docs for panic=abort by biscuitrescue · Pull Request #153295 · rust-lang/rust

biscuitrescue · 2026-03-02T15:45:36Z

The documentation for std::thread::panicking() has not been changed since v1.0, even though panic hooks were added in v1.10.
Current documentation is misleading for panic=abort

panicking() can return true in 2 different cases:

Thread unwinds due to panic
Panic hook is executing with panic=abort

r? @SpriteOvO

SpriteOvO

Thank you!

Not sure if I have r+ permission for this repo, let me try it...

@bors r+ rollup

View changes since this review

rust-bors · 2026-03-02T16:35:29Z

@SpriteOvO: 🔑 Insufficient privileges: not in review users

SpriteOvO · 2026-03-02T16:39:41Z

@rustbot reroll

SpriteOvO · 2026-03-02T16:42:45Z

library/std/src/thread/functions.rs

 /// |-----------|----------------------------------------------------------------------|
 /// | Linux     | [clock_nanosleep] (Monotonic clock)                                  |
-/// | BSD except OpenBSD | [clock_nanosleep] (Monotonic Clock)]                        |
+/// | BSD except OpenBSD | [clock_nanosleep] (Monotonic Clock)                        |


done and pushed.

tgross35 · 2026-03-02T17:46:45Z

library/std/src/thread/functions.rs

 }

-/// Determines whether the current thread is unwinding because of panic.
+/// Determines whether the current thread panicking.


“panicking” -> “is panicking”

tgross35 · 2026-03-02T17:52:33Z

library/std/src/thread/functions.rs

+///
+/// Note that this returns `true` when thread is unwinding due to panic,
+/// as well as when a panic hook is executing and program is configured to abort
+/// on panic (`panic=abort`)


Perhaps this could be rephrased as

… unwinding due to a panic or executing a panic hook. The latter case will still happen when panic=abort is set.

Since this returns true during panic hooks even when unwinding, right?

Also grammar nits on the current version: “due to a panic”, “and the program”, and missing period at the end of the sentence.

changed. also edited the underlying system calls table to match case and removed the trailing ] because it was sticking out to me

rustbot · 2026-03-02T17:52:46Z

Reminder, once the PR becomes ready for a review, use @rustbot ready.

biscuitrescue · 2026-03-02T22:01:06Z

@rustbot ready

tgross35 · 2026-03-03T00:13:53Z

library/std/src/thread/functions.rs

+/// Note that this returns `true` both when the thread is unwinding due to a
+/// panic or executing a panic hook. The latter case will still happen when


This returns true when the thread is either unwinding due to a panic, or when it is executing a panic hook. Note that the latter case ...

Minor rewording suggestion to move the "note" bit to the second sentence since it's more of a note, and slightly smooth out the first sentence.

Please squash commits after this then LGTM, thanks for the additional fixes

Done and commited. Sorry for the late work, I have an exam coming up.

Replying within a day is not "late work", there is no rush in open source :) one more typo to fix then I'll approve

Done, sorry about that. Also thankyou ;)

tgross35 · 2026-03-03T20:06:14Z

library/std/src/thread/functions.rs

+/// This returns `true` both when the thread is unwinding due to a panic.
+/// or executing a panic hook. Note that the latter case will still happen


Should be a , not . after panic

rephrasing and grammar

tgross35

Thank you!

@bors r+ rollup

View changes since this review

rust-bors · 2026-03-03T20:31:08Z

📌 Commit 014344b has been approved by tgross35

It is now in the queue for this repository.

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

@SpriteOvO

…r=tgross35 update panicking() docs for panic=abort fixes rust-lang#151458 The documentation for `std::thread::panicking()` has not been changed since v1.0, even though panic hooks were added in v1.10. Current documentation is misleading for `panic=abort` `panicking()` can return `true` in 2 different cases: 1. Thread unwinds due to panic 2. Panic hook is executing with `panic=abort` r? @SpriteOvO

…uwer Rollup of 5 pull requests Successful merges: - #153280 (Add regression test for `doc(fake_variadic)` on reexports) - #153358 (Boundary tests for various Duration-float operations) - #153272 (Add `Path::absolute` method as alias for `std::path::absolute`) - #153295 (update panicking() docs for panic=abort) - #153352 (Migration of `LintDiagnostic` - part 6)

Rollup of 8 pull requests Successful merges: - #153280 (Add regression test for `doc(fake_variadic)` on reexports) - #153302 (x86: reserve `bl` and `bh` registers to match `rbx`) - #153358 (Boundary tests for various Duration-float operations) - #153048 (Improve irrefutable let-else lint wording) - #153258 (diag: Suppress `.clone()` suggestion inside derive macro expansions) - #153272 (Add `Path::absolute` method as alias for `std::path::absolute`) - #153295 (update panicking() docs for panic=abort) - #153352 (Migration of `LintDiagnostic` - part 6)

@SpriteOvO

Rollup merge of #153295 - biscuitrescue:fix-panicking-docs, r=tgross35 update panicking() docs for panic=abort fixes #151458 The documentation for `std::thread::panicking()` has not been changed since v1.0, even though panic hooks were added in v1.10. Current documentation is misleading for `panic=abort` `panicking()` can return `true` in 2 different cases: 1. Thread unwinds due to panic 2. Panic hook is executing with `panic=abort` r? @SpriteOvO

rustbot assigned SpriteOvO Mar 2, 2026

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 Mar 2, 2026

SpriteOvO added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Mar 2, 2026

SpriteOvO approved these changes Mar 2, 2026

View reviewed changes

rustbot assigned tgross35 and unassigned SpriteOvO Mar 2, 2026

SpriteOvO reviewed Mar 2, 2026

View reviewed changes

biscuitrescue force-pushed the fix-panicking-docs branch from 9fd469d to 7072f83 Compare March 2, 2026 16:48

tgross35 requested changes Mar 2, 2026

View reviewed changes

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 2, 2026

biscuitrescue force-pushed the fix-panicking-docs branch from b5e609d to 6ac34fc Compare March 2, 2026 21:59

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 2, 2026

biscuitrescue force-pushed the fix-panicking-docs branch from 6ac34fc to bf08176 Compare March 2, 2026 22:02

tgross35 reviewed Mar 3, 2026

View reviewed changes

biscuitrescue force-pushed the fix-panicking-docs branch from bf08176 to d8330d0 Compare March 3, 2026 20:00

biscuitrescue requested a review from tgross35 March 3, 2026 20:03

tgross35 reviewed Mar 3, 2026

View reviewed changes

update panicking() docs for panic=abort

014344b

rephrasing and grammar

biscuitrescue force-pushed the fix-panicking-docs branch from d8330d0 to 014344b Compare March 3, 2026 20:08

biscuitrescue requested a review from tgross35 March 3, 2026 20:17

tgross35 approved these changes Mar 3, 2026

View reviewed changes

rust-bors bot added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Mar 3, 2026

rust-bors bot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 3, 2026

JonathanBrouwer mentioned this pull request Mar 3, 2026

Rollup of 5 pull requests #153365

Closed

Zalathar mentioned this pull request Mar 4, 2026

Rollup of 8 pull requests #153377

Merged

rust-bors bot merged commit 49966fe into rust-lang:main Mar 4, 2026
11 checks passed

rustbot added this to the 1.96.0 milestone Mar 4, 2026

	/// \| BSD except OpenBSD \| [clock_nanosleep] (Monotonic Clock) \|
	/// \| BSD except OpenBSD \| [clock_nanosleep] (Monotonic Clock) \|

		/// Note that this returns `true` both when the thread is unwinding due to a
		/// panic or executing a panic hook. The latter case will still happen when

		/// This returns `true` both when the thread is unwinding due to a panic.
		/// or executing a panic hook. Note that the latter case will still happen

Uh oh!

Conversation

biscuitrescue commented Mar 2, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SpriteOvO left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rust-bors bot commented Mar 2, 2026

Uh oh!

SpriteOvO commented Mar 2, 2026

Uh oh!

SpriteOvO Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

biscuitrescue Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustbot commented Mar 2, 2026

Uh oh!

biscuitrescue commented Mar 2, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tgross35 left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rust-bors bot commented Mar 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

biscuitrescue commented Mar 2, 2026 •

edited by rustbot

Loading

SpriteOvO left a comment •

edited by rustbot

Loading

SpriteOvO Mar 2, 2026 •

edited

Loading

biscuitrescue Mar 2, 2026 •

edited

Loading

tgross35 left a comment •

edited by rustbot

Loading