Skip to content

Commit b38732f

Browse files
committed
Add "Platform-specific behavior" heading and link to changes disclaimer
1 parent 1354a38 commit b38732f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Diff for: library/std/src/io/stdio.rs

+5
Original file line numberDiff line numberDiff line change
@@ -1055,9 +1055,14 @@ pub trait IsTerminal: crate::sealed::Sealed {
10551055
/// `false`. This will also return `false` if an unexpected error occurred, such as from
10561056
/// passing an invalid file descriptor.
10571057
///
1058+
/// # Platform-specific behavior
1059+
///
10581060
/// On Windows, in addition to detecting consoles, this currently uses some heuristics to
10591061
/// detect older msys/cygwin/mingw pseudo-terminals based on device name: devices with names
10601062
/// starting with `msys-` or `cygwin-` and ending in `-pty` will be considered terminals.
1063+
/// Note that this [may change in the future][changes].
1064+
///
1065+
/// [changes]: io#platform-specific-behavior
10611066
fn is_terminal(&self) -> bool;
10621067
}
10631068

0 commit comments

Comments
 (0)