Improve OpenptyResult documentation

nix-rust · Jul 18, 2017 · bb4105a · bb4105a
1 parent 5d29650
commit bb4105a
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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,