about summary refs log tree commit diff
path: root/library/std/src/io/stdio.rs
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2023-03-28 11:26:43 +0900
committerJosh Triplett <josh@joshtriplett.org>2023-03-28 11:26:43 +0900
commitb38732f25c326659e860a0fac81775bd07932223 (patch)
treef51df5787ac8f31aed9ea209db57260e4d201543 /library/std/src/io/stdio.rs
parent1354a38afd7c7183e4e7f5f17bef7fccfc4d2a06 (diff)
downloadrust-b38732f25c326659e860a0fac81775bd07932223.tar.gz
rust-b38732f25c326659e860a0fac81775bd07932223.zip
Add "Platform-specific behavior" heading and link to changes disclaimer
Diffstat (limited to 'library/std/src/io/stdio.rs')
-rw-r--r--library/std/src/io/stdio.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/library/std/src/io/stdio.rs b/library/std/src/io/stdio.rs
index 7c1bf488a21..1a3200a5c62 100644
--- a/library/std/src/io/stdio.rs
+++ b/library/std/src/io/stdio.rs
@@ -1055,9 +1055,14 @@ pub trait IsTerminal: crate::sealed::Sealed {
     /// `false`. This will also return `false` if an unexpected error occurred, such as from
     /// passing an invalid file descriptor.
     ///
+    /// # Platform-specific behavior
+    ///
     /// On Windows, in addition to detecting consoles, this currently uses some heuristics to
     /// detect older msys/cygwin/mingw pseudo-terminals based on device name: devices with names
     /// starting with `msys-` or `cygwin-` and ending in `-pty` will be considered terminals.
+    /// Note that this [may change in the future][changes].
+    ///
+    /// [changes]: io#platform-specific-behavior
     fn is_terminal(&self) -> bool;
 }