From bb4105afceba87b75d17481ef68a2ae9e79ee7be Mon Sep 17 00:00:00 2001
From: Alan Somers <asomers@gmail.com>
Date: Mon, 17 Jul 2017 18:27:17 -0600
Subject: Improve OpenptyResult documentation

---
 src/pty.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

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,
-- 
cgit v1.2.3