summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlan Somers <asomers@gmail.com>2017-07-17 18:27:17 -0600
committerAlan Somers <asomers@gmail.com>2017-07-17 18:27:44 -0600
commitbb4105afceba87b75d17481ef68a2ae9e79ee7be (patch)
tree3064f6c128b592d6564eb82bef01d6ff54ea5225
parent5d296505b597d29bf6b339904f7f1550febe863d (diff)
downloadnix-bb4105afceba87b75d17481ef68a2ae9e79ee7be.zip
Improve OpenptyResult documentation
-rw-r--r--src/pty.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/pty.rs b/src/pty.rs
index fd8ad98e..26c8b500 100644
--- a/src/pty.rs
+++ b/src/pty.rs
@@ -14,7 +14,8 @@ use {Errno, Result, Error, fcntl};
/// Representation of a master/slave pty pair
///
-/// This is returned by `openpty`
+/// This is returned by `openpty`. Note that this type does *not* implement `Drop`, so the user
+/// must manually close the file descriptors.
pub struct OpenptyResult {
pub master: RawFd,
pub slave: RawFd,