summaryrefslogtreecommitdiffstats
path: root/Doc/library/getpass.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-04-14 14:28:58 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-04-14 14:28:58 (GMT)
commit604453c9cea5dfcc5c6373028d0c30a4bd4f94f2 (patch)
tree2b9f009ad242d9e2df952be6814bafd1f87343b5 /Doc/library/getpass.rst
parent04d8a245f162b33e6c861ba0869918d9262be63e (diff)
downloadcpython-604453c9cea5dfcc5c6373028d0c30a4bd4f94f2.zip
cpython-604453c9cea5dfcc5c6373028d0c30a4bd4f94f2.tar.gz
cpython-604453c9cea5dfcc5c6373028d0c30a4bd4f94f2.tar.bz2
#21169: add comment and doc update for getpass change.
Diffstat (limited to 'Doc/library/getpass.rst')
-rw-r--r--Doc/library/getpass.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/library/getpass.rst b/Doc/library/getpass.rst
index ffe2b12..211563e 100644
--- a/Doc/library/getpass.rst
+++ b/Doc/library/getpass.rst
@@ -13,10 +13,11 @@ The :mod:`getpass` module provides two functions:
.. function:: getpass(prompt='Password: ', stream=None)
Prompt the user for a password without echoing. The user is prompted using
- the string *prompt*, which defaults to ``'Password: '``. On Unix, the prompt
- is written to the file-like object *stream*. *stream* defaults to the
- controlling terminal (:file:`/dev/tty`) or if that is unavailable to
- ``sys.stderr`` (this argument is ignored on Windows).
+ the string *prompt*, which defaults to ``'Password: '``. On Unix, the
+ prompt is written to the file-like object *stream* using the replace error
+ handler if needed. *stream* defaults to the controlling terminal
+ (:file:`/dev/tty`) or if that is unavailable to ``sys.stderr`` (this
+ argument is ignored on Windows).
If echo free input is unavailable getpass() falls back to printing
a warning message to *stream* and reading from ``sys.stdin`` and