summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Cullen <david.cullen@technicolor.com>2016-06-29 12:33:26 -0400
committerDavid Cullen <david.cullen@technicolor.com>2016-06-29 12:33:26 -0400
commita0f5cf5feeb8f0c7eda223939f5810db258c77e5 (patch)
treec5970a7fefebe98326a3344d63a381e512d8ff3d
parent5c18bd4841b4d70c4f08bba6d85411c3b69d3224 (diff)
downloadpexpect-a0f5cf5feeb8f0c7eda223939f5810db258c77e5.tar.gz
Improve docstring for read_nonblocking in fdspawn.
-rw-r--r--pexpect/fdpexpect.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/pexpect/fdpexpect.py b/pexpect/fdpexpect.py
index 25b5c8d..785bc10 100644
--- a/pexpect/fdpexpect.py
+++ b/pexpect/fdpexpect.py
@@ -115,10 +115,10 @@ class fdspawn(SpawnBase):
self.write(s)
def read_nonblocking(self, size=1, timeout=-1):
- '''The read_nonblocking method of fdspawn assumes that the file
- will never block. This is not the case for all file like objects
- that support fileno (e.g. POSIX sockets and serial ports). So we
- use select to implement the timeout on POSIX.'''
+ """The read_nonblocking method of SpawnBase assumes that a call to
+ os.read will not block. This is not the case for POSIX file like
+ objects like sockets and serial ports. So we use select to implement
+ the timeout on POSIX."""
if os.name == 'posix':
if timeout == -1:
timeout = self.timeout