diff options
| author | Thomas Kluyver <takowl@gmail.com> | 2014-01-23 15:36:39 -0800 |
|---|---|---|
| committer | Thomas Kluyver <takowl@gmail.com> | 2014-01-23 15:36:39 -0800 |
| commit | bb6ba03af13f8b3adfc64c3986ca522f634befbc (patch) | |
| tree | d79e109c02094ad02f187645b468cde595b63e12 /doc | |
| parent | 13ec3b0e134159d0168811862a9d7980847ca4e0 (diff) | |
| download | pexpect-git-bb6ba03af13f8b3adfc64c3986ca522f634befbc.tar.gz | |
Fix documentation of using auto_prompt_reset.
Closes gh-35
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/pxssh.rst | 11 |
1 files changed, 3 insertions, 8 deletions
diff --git a/doc/api/pxssh.rst b/doc/api/pxssh.rst index c3388f0..bc20229 100644 --- a/doc/api/pxssh.rst +++ b/doc/api/pxssh.rst @@ -12,18 +12,13 @@ pxssh class .. automethod:: __init__ - .. attribute:: auto_prompt_reset - - Set this to False to prevent :meth:`login` from setting a unique prompt - which can easily be located. - .. attribute:: PROMPT - The regex pattern to search for to find the prompt. If - :attr:`auto_prompt_reset` is False, you must set this attribute manually. + The regex pattern to search for to find the prompt. If you call :meth:`login` + with ``auto_prompt_reset=False``, you must set this attribute manually. .. automethod:: login .. automethod:: logout .. automethod:: prompt .. automethod:: sync_original_prompt - .. automethod:: set_unique_prompt
\ No newline at end of file + .. automethod:: set_unique_prompt |