The third and final doc-string sweep by Ka-Ping Yee.
The attached patches update the standard library so that all modules
have docstrings beginning with one-line summaries.
A new docstring was added to formatter. The docstring for os.py
was updated to mention nt, os2, ce in addition to posix, dos, mac.
diff --git a/Lib/tty.py b/Lib/tty.py
index 86530cf..20a31c0 100644
--- a/Lib/tty.py
+++ b/Lib/tty.py
@@ -1,4 +1,5 @@
-# tty.py -- Terminal utilities.
+"""Terminal utilities."""
+
# Author: Steen Lumholt.
from TERMIOS import *
@@ -13,8 +14,8 @@
OSPEED = 5
CC = 6
-# Put terminal into a raw mode.
def setraw(fd, when=TCSAFLUSH):
+ """Put terminal into a raw mode."""
mode = tcgetattr(fd)
mode[IFLAG] = mode[IFLAG] & ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON)
mode[OFLAG] = mode[OFLAG] & ~(OPOST)
@@ -25,8 +26,8 @@
mode[CC][VTIME] = 0
tcsetattr(fd, when, mode)
-# Put terminal into a cbreak mode.
def setcbreak(fd, when=TCSAFLUSH):
+ """Put terminal into a cbreak mode."""
mode = tcgetattr(fd)
mode[LFLAG] = mode[LFLAG] & ~(ECHO | ICANON)
mode[CC][VMIN] = 1