diff options
| author | Tapple <mfulmer@cisco.com> | 2023-02-21 17:02:11 -0500 |
|---|---|---|
| committer | Tapple <mfulmer@cisco.com> | 2023-02-21 17:02:11 -0500 |
| commit | c9214888333865dd9f12c310d12ee40884d83fee (patch) | |
| tree | a86bf06aa3bc091ab5fd0ca8244e0dd7970f825c | |
| parent | 31072de58b4d37a9895a35b28b3efbe12750b996 (diff) | |
| download | pexpect-c9214888333865dd9f12c310d12ee40884d83fee.tar.gz | |
docs
| -rw-r--r-- | pexpect/fdpexpect.py | 6 | ||||
| -rw-r--r-- | pexpect/socket_pexpect.py | 6 |
2 files changed, 7 insertions, 5 deletions
diff --git a/pexpect/fdpexpect.py b/pexpect/fdpexpect.py index 6847d66..140bdfe 100644 --- a/pexpect/fdpexpect.py +++ b/pexpect/fdpexpect.py @@ -1,8 +1,10 @@ -'''This is like pexpect, but it will work with any file descriptor that you +'''This is like :mod:`pexpect`, but it will work with any file descriptor that you pass it. You are responsible for opening and close the file descriptor. This allows you to use Pexpect with sockets and named pipes (FIFOs). -..note:: socket.fileno() does not work on windows. Use `pexpect.socket_pexpect` for cross-platform socket support +.. note:: + socket.fileno() does not give a readable file descriptor on windows. + Use :mod:`pexpect.socket_pexpect` for cross-platform socket support PEXPECT LICENSE diff --git a/pexpect/socket_pexpect.py b/pexpect/socket_pexpect.py index 5bee9b1..cb11ac2 100644 --- a/pexpect/socket_pexpect.py +++ b/pexpect/socket_pexpect.py @@ -1,5 +1,5 @@ -"""This is like pexpect, but it will work with any socket that you -pass it. You are responsible for opening and close the socket. +"""This is like :mod:`pexpect`, but it will work with any socket that you +pass it. You are responsible for opening and closing the socket. PEXPECT LICENSE @@ -30,7 +30,7 @@ __all__ = ["SocketSpawn"] class SocketSpawn(SpawnBase): - """This is like pexpect.fdspawn but uses the cross-platform python socket api, + """This is like :mod:`pexpect.fdpexpect` but uses the cross-platform python socket api, rather than the unix-specific file descriptor api. Thus, it works with remote connections on both unix and windows.""" |