diff options
| author | John Arundel <john@bitfieldconsulting.com> | 2024-07-15 12:26:30 +0100 |
|---|---|---|
| committer | John Arundel <john@bitfieldconsulting.com> | 2024-07-26 13:26:33 +0100 |
| commit | a19472a93e2eecce1477011fa9f7ec49b45ca164 (patch) | |
| tree | 3b7cee954a0c37ee98fbedd430fbf46a2ea12559 /library/std/src/panic.rs | |
| parent | 83d67685acb520fe68d5d5adde4b25fb725490de (diff) | |
| download | rust-a19472a93e2eecce1477011fa9f7ec49b45ca164.tar.gz rust-a19472a93e2eecce1477011fa9f7ec49b45ca164.zip | |
Fix doc nits
Many tiny changes to stdlib doc comments to make them consistent (for example "Returns foo", rather than "Return foo", per RFC1574), adding missing periods, paragraph breaks, backticks for monospace style, and other minor nits. https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
Diffstat (limited to 'library/std/src/panic.rs')
| -rw-r--r-- | library/std/src/panic.rs | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/library/std/src/panic.rs b/library/std/src/panic.rs index c5d1a893ee8..b0c7804fd2b 100644 --- a/library/std/src/panic.rs +++ b/library/std/src/panic.rs @@ -249,7 +249,7 @@ pub use core::panic::Location; #[stable(feature = "catch_unwind", since = "1.9.0")] pub use core::panic::{AssertUnwindSafe, RefUnwindSafe, UnwindSafe}; -/// Panic the current thread with the given message as the panic payload. +/// Panics the current thread with the given message as the panic payload. /// /// The message can be of any (`Any + Send`) type, not just strings. /// @@ -380,7 +380,7 @@ pub fn resume_unwind(payload: Box<dyn Any + Send>) -> ! { panicking::rust_panic_without_hook(payload) } -/// Make all future panics abort directly without running the panic hook or unwinding. +/// Makes all future panics abort directly without running the panic hook or unwinding. /// /// There is no way to undo this; the effect lasts until the process exits or /// execs (or the equivalent). @@ -461,7 +461,7 @@ impl BacktraceStyle { // Internally stores equivalent of an Option<BacktraceStyle>. static SHOULD_CAPTURE: AtomicU8 = AtomicU8::new(0); -/// Configure whether the default panic hook will capture and display a +/// Configures whether the default panic hook will capture and display a /// backtrace. /// /// The default value for this setting may be set by the `RUST_BACKTRACE` |
