summaryrefslogtreecommitdiff
path: root/pexpect/pty_spawn.py
diff options
context:
space:
mode:
authorJeff Quast <contact@jeffquast.com>2015-09-21 12:35:56 -0700
committerJeff Quast <contact@jeffquast.com>2015-09-21 12:35:56 -0700
commit6a8e9b2ad73104740a48b0c8d6c9fd0cc2ae9e92 (patch)
tree01f7ce7c19624557e6461656d18e592906cb8c01 /pexpect/pty_spawn.py
parentf5b854e76e9e811c7470d886fbc20003963e783b (diff)
downloadpexpect-git-6a8e9b2ad73104740a48b0c8d6c9fd0cc2ae9e92.tar.gz
will raise -> will be raised + newline
Diffstat (limited to 'pexpect/pty_spawn.py')
-rw-r--r--pexpect/pty_spawn.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/pexpect/pty_spawn.py b/pexpect/pty_spawn.py
index 778bbdc..d1df81c 100644
--- a/pexpect/pty_spawn.py
+++ b/pexpect/pty_spawn.py
@@ -87,8 +87,9 @@ class spawn(SpawnBase):
amount of data where you want to match. The searchwindowsize does not
affect the size of the incoming data buffer. You will still have
access to the full buffer after expect() returns.
+
When the keyword argument ``timeout`` is specified as a number,
- (default: *30*), then :class:`TIMEOUT` will raise after the value
+ (default: *30*), then :class:`TIMEOUT` will be raised after the value
specified has elapsed, in seconds, for any of the :meth:`~.expect`
family of method calls. When None, TIMEOUT will not be raised, and
:meth:`~.expect` may block indefinitely until match.