Skip to content

Commit 355445b

Browse files
committed
[library/std/src/process.rs] Update docstring with @joshtriplett's replacement text
1 parent 79855bb commit 355445b

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

std/src/process.rs

+8-4
Original file line numberDiff line numberDiff line change
@@ -1937,10 +1937,14 @@ impl crate::error::Error for ExitStatusError {}
19371937
/// to its parent under normal termination.
19381938
///
19391939
/// `ExitCode` is intended to be consumed only by the standard library (via
1940-
/// [`Termination::report()`]), and intentionally does not provide accessors like
1941-
/// `PartialEq`, `Eq`, or `Hash`. Instead the standard library provides the
1942-
/// canonical `SUCCESS` and `FAILURE` exit codes as well as `From<u8> for
1943-
/// ExitCode` for constructing other arbitrary exit codes.
1940+
/// [`Termination::report()`]). For forwards compatibility with potentially
1941+
/// unusual targets, this type currently does not provide `Eq`, `Hash`, or
1942+
/// access to the raw value. This type does provide `PartialEq` for
1943+
/// comparison, but note that there may potentially be multiple failure
1944+
/// codes, some of which will _not_ compare equal to `ExitCode::FAILURE`.
1945+
/// The standard library provides the canonical `SUCCESS` and `FAILURE`
1946+
/// exit codes as well as `From<u8> for ExitCode` for constructing other
1947+
/// arbitrary exit codes.
19441948
///
19451949
/// # Portability
19461950
///

0 commit comments

Comments
 (0)