summaryrefslogtreecommitdiffstats
path: root/Lib/formatter.py
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>2000-02-04 15:39:30 (GMT)
committerGuido van Rossum <guido@python.org>2000-02-04 15:39:30 (GMT)
commit4b8c6eaf8b287a27e0054cf6c751448b2077e83b (patch)
treedfe117765389bf4415832ca888f0117f1feba0f3 /Lib/formatter.py
parente7b146fb3bdca62a0d5ecc06dbf3348e5a4fe757 (diff)
downloadcpython-4b8c6eaf8b287a27e0054cf6c751448b2077e83b.zip
cpython-4b8c6eaf8b287a27e0054cf6c751448b2077e83b.tar.gz
cpython-4b8c6eaf8b287a27e0054cf6c751448b2077e83b.tar.bz2
Actually, the previous batch's comment should have been different;
*this* set of patches is Ka-Ping's final sweep: 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.
Diffstat (limited to 'Lib/formatter.py')
-rw-r--r--Lib/formatter.py20
1 files changed, 20 insertions, 0 deletions
diff --git a/Lib/formatter.py b/Lib/formatter.py
index 4b340d5..4d6a129 100644
--- a/Lib/formatter.py
+++ b/Lib/formatter.py
@@ -1,3 +1,23 @@
+"""Generic output formatting.
+
+Formatter objects transform an abstract flow of formatting events into
+specific output events on writer objects. Formatters manage several stack
+structures to allow various properties of a writer object to be changed and
+restored; writers need not be able to handle relative changes nor any sort
+of ``change back'' operation. Specific writer properties which may be
+controlled via formatter objects are horizontal alignment, font, and left
+margin indentations. A mechanism is provided which supports providing
+arbitrary, non-exclusive style settings to a writer as well. Additional
+interfaces facilitate formatting events which are not reversible, such as
+paragraph separation.
+
+Writer objects encapsulate device interfaces. Abstract devices, such as
+file formats, are supported as well as physical devices. The provided
+implementations all work with abstract devices. The interface makes
+available mechanisms for setting the properties which formatter objects
+manage and inserting data into the output.
+"""
+
import string
import sys
from types import StringType