summaryrefslogtreecommitdiffstats
path: root/Doc/library/tty.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-09-16 15:58:14 (GMT)
committerGeorg Brandl <georg@python.org>2009-09-16 15:58:14 (GMT)
commit7f01a13e7c47b6c4bcca601b597378408f3ceb2e (patch)
tree938cccc27452ea421eb5b80521ddd8849661616b /Doc/library/tty.rst
parentfe99105835b59e66ca1fd53ea3f8bcec3ec7cb3c (diff)
downloadcpython-7f01a13e7c47b6c4bcca601b597378408f3ceb2e.zip
cpython-7f01a13e7c47b6c4bcca601b597378408f3ceb2e.tar.gz
cpython-7f01a13e7c47b6c4bcca601b597378408f3ceb2e.tar.bz2
Last round of adapting style of documenting argument default values.
Diffstat (limited to 'Doc/library/tty.rst')
-rw-r--r--Doc/library/tty.rst5
1 files changed, 2 insertions, 3 deletions
diff --git a/Doc/library/tty.rst b/Doc/library/tty.rst
index 688faee..d13c6f9 100644
--- a/Doc/library/tty.rst
+++ b/Doc/library/tty.rst
@@ -1,4 +1,3 @@
-
:mod:`tty` --- Terminal control functions
=========================================
@@ -17,14 +16,14 @@ Because it requires the :mod:`termios` module, it will work only on Unix.
The :mod:`tty` module defines the following functions:
-.. function:: setraw(fd[, when])
+.. function:: setraw(fd, when=termios.TCSAFLUSH)
Change the mode of the file descriptor *fd* to raw. If *when* is omitted, it
defaults to :const:`termios.TCSAFLUSH`, and is passed to
:func:`termios.tcsetattr`.
-.. function:: setcbreak(fd[, when])
+.. function:: setcbreak(fd, when=termios.TCSAFLUSH)
Change the mode of file descriptor *fd* to cbreak. If *when* is omitted, it
defaults to :const:`termios.TCSAFLUSH`, and is passed to