New docstrings mainly for module titles
authordamian
Fri, 12 Dec 2008 17:55:22 +0000
changeset 3032 22224b1b4d24
parent 3031 6f90e7668adb
child 3033 0c9602603837
New docstrings mainly for module titles
src/reportlab/graphics/__init__.py
src/reportlab/graphics/barcode/__init__.py
src/reportlab/graphics/charts/__init__.py
src/reportlab/graphics/charts/areas.py
src/reportlab/graphics/charts/axes.py
src/reportlab/graphics/charts/barcharts.py
src/reportlab/graphics/charts/doughnut.py
src/reportlab/graphics/charts/legends.py
src/reportlab/graphics/charts/linecharts.py
src/reportlab/graphics/charts/lineplots.py
src/reportlab/graphics/charts/markers.py
src/reportlab/graphics/charts/piecharts.py
src/reportlab/graphics/charts/spider.py
src/reportlab/graphics/charts/utils.py
src/reportlab/graphics/renderPDF.py
src/reportlab/graphics/renderPM.py
src/reportlab/graphics/renderPS.py
src/reportlab/graphics/renderSVG.py
src/reportlab/graphics/renderbase.py
src/reportlab/graphics/samples/__init__.py
src/reportlab/graphics/shapes.py
src/reportlab/graphics/testdrawings.py
src/reportlab/graphics/testshapes.py
src/reportlab/graphics/widgetbase.py
src/reportlab/graphics/widgets/__init__.py
src/reportlab/graphics/widgets/eventcal.py
src/reportlab/graphics/widgets/flags.py
src/reportlab/graphics/widgets/markers.py
src/reportlab/graphics/widgets/signsandsymbols.py
src/reportlab/pdfbase/__init__.py
src/reportlab/pdfbase/_can_cmap_data.py
src/reportlab/pdfbase/_fontdata.py
src/reportlab/pdfbase/pdfmetrics.py
src/reportlab/pdfbase/pdfpattern.py
src/reportlab/pdfbase/ttfonts.py
src/reportlab/pdfgen/__init__.py
src/reportlab/pdfgen/pycanvas.py
src/reportlab/platypus/__init__.py
src/reportlab/platypus/frames.py
src/reportlab/platypus/paragraph.py
src/reportlab/platypus/paraparser.py
src/reportlab/platypus/tableofcontents.py
src/reportlab/platypus/xpreformatted.py
src/reportlab/rl_config.py
--- a/src/reportlab/graphics/__init__.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/__init__.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,4 +1,6 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/__init__.py
-__version__=''' $Id$ '''
\ No newline at end of file
+__version__=''' $Id$ '''
+__doc__='''Framework for reusable object graphics, in PDF or bitmap form'''
+
--- a/src/reportlab/graphics/barcode/__init__.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/barcode/__init__.py	Fri Dec 12 17:55:22 2008 +0000
@@ -31,6 +31,7 @@
 #
 
 __version__ = '0.9'
+__doc__='''Popular barcodes available as reusable widgets'''
 
 def getCodes():
     """Returns a dict mapping code names to widgets"""
--- a/src/reportlab/graphics/charts/__init__.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/__init__.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,4 +1,5 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/__init__.py
-__version__=''' $Id$ '''
\ No newline at end of file
+__version__=''' $Id$ '''
+__doc__='''Business charts'''
--- a/src/reportlab/graphics/charts/areas.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/areas.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,9 +1,10 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/areas.py
-"""This module defines a Area mixin classes
-"""
+
 __version__=''' $Id$ '''
+__doc__='''This module defines a Area mixin classes'''
+
 from reportlab.lib.validators import isNumber, isColor, isColorOrNone, isNoneOrShape
 from reportlab.graphics.widgetbase import Widget
 from reportlab.graphics.shapes import Rect, Group, Line, Polygon
--- a/src/reportlab/graphics/charts/axes.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/axes.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,7 +1,8 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/axes.py
-"""Collection of axes for charts.
+__version__=''' $Id$ '''
+__doc__="""Collection of axes for charts.
 
 The current collection comprises axes for charts using cartesian
 coordinate systems. All axes might have tick marks and labels.
@@ -30,7 +31,6 @@
 at any absolute value (specified in points) or at some value of
 the former axes in its own coordinate system.
 """
-__version__=''' $Id$ '''
 
 import string
 
--- a/src/reportlab/graphics/charts/barcharts.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/barcharts.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,14 +1,14 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/barcharts.py
-"""This module defines a variety of Bar Chart components.
+__version__=''' $Id$ '''
+__doc__="""This module defines a variety of Bar Chart components.
 
 The basic flavors are Side-by-side, available in horizontal and
 vertical versions.
 
 Stacked and percentile bar charts to follow...
 """
-__version__=''' $Id$ '''
 
 import copy
 
--- a/src/reportlab/graphics/charts/doughnut.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/doughnut.py	Fri Dec 12 17:55:22 2008 +0000
@@ -3,13 +3,13 @@
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/doughnut.py
 # doughnut chart
 
-"""Doughnut chart
+__version__=''' $Id$ '''
+__doc__="""Doughnut chart
 
 Produces a circular chart like the doughnut charts produced by Excel.
 Can handle multiple series (which produce concentric 'rings' in the chart).
 
 """
-__version__=''' $Id$ '''
 
 import copy
 from math import sin, cos, pi
--- a/src/reportlab/graphics/charts/legends.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/legends.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,9 +1,9 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/legends.py
-"""This will be a collection of legends to be used with charts.
-"""
+
 __version__=''' $Id$ '''
+__doc__="""This will be a collection of legends to be used with charts."""
 
 import copy, operator
 
--- a/src/reportlab/graphics/charts/linecharts.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/linecharts.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,10 +1,10 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/linecharts.py
-"""
-This modules defines a very preliminary Line Chart example.
-"""
+
 __version__=''' $Id$ '''
+__doc__="""This modules defines a very preliminary Line Chart example."""
+
 from reportlab.lib import colors
 from reportlab.lib.validators import isNumber, isColor, isColorOrNone, isListOfStrings, \
                                     isListOfStringsOrNone, SequenceOf, isBoolean, NoneOr, \
--- a/src/reportlab/graphics/charts/lineplots.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/lineplots.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,9 +1,9 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/lineplots.py
-"""This module defines a very preliminary Line Plot example.
-"""
+
 __version__=''' $Id$ '''
+__doc__="""This module defines a very preliminary Line Plot example."""
 
 import string, time
 
--- a/src/reportlab/graphics/charts/markers.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/markers.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,13 +1,14 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/markers.py
-"""
-This modules defines a collection of markers used in charts.
+
+__version__=''' $Id$ '''
+__doc__="""This modules defines a collection of markers used in charts.
 
 The make* functions return a simple shape or a widget as for
 the smiley.
 """
-__version__=''' $Id$ '''
+
 from reportlab.lib import colors
 from reportlab.graphics.shapes import Rect, Line, Circle, Polygon
 from reportlab.graphics.widgets.signsandsymbols import SmileyFace
@@ -78,4 +79,4 @@
     s.y = y-d
     s.size = d*2
 
-    return s
\ No newline at end of file
+    return s
--- a/src/reportlab/graphics/charts/piecharts.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/piecharts.py	Fri Dec 12 17:55:22 2008 +0000
@@ -6,12 +6,12 @@
 #a wedges collection whic lets you customize the group or every individual
 #wedge.
 
-"""Basic Pie Chart class.
+__version__=''' $Id$ '''
+__doc__="""Basic Pie Chart class.
 
 This permits you to customize and pop out individual wedges;
 supports elliptical and circular pies.
 """
-__version__=''' $Id$ '''
 
 import copy
 from math import sin, cos, pi
--- a/src/reportlab/graphics/charts/spider.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/spider.py	Fri Dec 12 17:55:22 2008 +0000
@@ -3,13 +3,13 @@
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/spider.py
 # spider chart, also known as radar chart
 
-"""Spider Chart
+__version__=''' $Id$ '''
+__doc__="""Spider Chart
 
 Normal use shows variation of 5-10 parameters against some 'norm' or target.
 When there is more than one series, place the series with the largest
 numbers first, as it will be overdrawn by each successive one.
 """
-__version__=''' $Id$ '''
 
 import copy
 from math import sin, cos, pi
--- a/src/reportlab/graphics/charts/utils.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/charts/utils.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,8 +1,9 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/charts/utils.py
-"Utilities used here and there."
+
 __version__=''' $Id$ '''
+__doc__="Utilities used here and there."
 
 from time import mktime, gmtime, strftime
 import string
--- a/src/reportlab/graphics/renderPDF.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/renderPDF.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,14 +2,18 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/renderPDF.py
 # renderPDF - draws Drawings onto a canvas
-"""
-Usage:
-- import renderpdf
-- renderpdf.draw(drawing, canvas, x, y)
+
+__version__=''' $Id$ '''
+__doc__="""Render Drawing objects within others PDFs or standalone
+
+Usage::
+    
+    import renderpdf
+    renderpdf.draw(drawing, canvas, x, y)
+
 Execute the script to see some test drawings.
 changed
 """
-__version__=''' $Id$ '''
 
 from reportlab.graphics.shapes import *
 from reportlab.pdfgen.canvas import Canvas
--- a/src/reportlab/graphics/renderPM.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/renderPM.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,10 +2,13 @@
 #see license.txt for license details
 #history www.reportlab.co.uk/rl-cgi/viewcvs.cgi/rlextra/graphics/Csrc/renderPM/renderP.py
 __version__=''' $Id$ '''
-"""
-Usage:
-- from reportlab.graphics import renderPM
-- renderPM.drawToFile(drawing,filename,fmt='GIF',configPIL={....})
+__doc__="""Render drawing objects in common bitmap formats
+
+Usage::
+
+    from reportlab.graphics import renderPM
+    renderPM.drawToFile(drawing,filename,fmt='GIF',configPIL={....})
+
 Other functions let you create a PM drawing as string or into a PM buffer.
 Execute the script to see some test drawings."""
 
--- a/src/reportlab/graphics/renderPS.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/renderPS.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,6 +2,8 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/renderPS.py
 __version__=''' $Id$ '''
+__doc__="""Render drawing objects in Postscript"""
+
 import string, types
 from reportlab.pdfbase.pdfmetrics import getFont, stringWidth, unicode2T1 # for font info
 from reportlab.lib.utils import fp_str, getStringIO
--- a/src/reportlab/graphics/renderSVG.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/renderSVG.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,4 +1,4 @@
-"""An experimental SVG renderer for the ReportLab graphics framework.
+__doc__="""An experimental SVG renderer for the ReportLab graphics framework.
 
 This will create SVG code from the ReportLab Graphics API (RLG).
 To read existing SVG code and convert it into ReportLab graphics
--- a/src/reportlab/graphics/renderbase.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/renderbase.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,12 +1,9 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/renderbase.py
-"""
-Superclass for renderers to factor out common functionality and default implementations.
-"""
-
 
 __version__=''' $Id $ '''
+__doc__='''Superclass for renderers to factor out common functionality and default implementations.'''
 
 from reportlab.graphics.shapes import *
 from reportlab.lib.validators import DerivedValue
--- a/src/reportlab/graphics/samples/__init__.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/samples/__init__.py	Fri Dec 12 17:55:22 2008 +0000
@@ -0,0 +1,1 @@
+__doc__="""Example drawings to review, used in autogenerated docs"""
--- a/src/reportlab/graphics/shapes.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/shapes.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,10 +1,9 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/shapes.py
-"""
-core of the graphics library - defines Drawing and Shapes
-"""
+
 __version__=''' $Id$ '''
+__doc__='''Core of the graphics library - defines Drawing and Shapes'''
 
 import string, os, sys
 from math import pi, cos, sin, tan
--- a/src/reportlab/graphics/testdrawings.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/testdrawings.py	Fri Dec 12 17:55:22 2008 +0000
@@ -3,7 +3,9 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/testdrawings.py
 __version__=''' $Id $ '''
-"""This contains a number of routines to generate test drawings
+__doc__="""Defines some standard drawings to use as test cases
+
+This contains a number of routines to generate test drawings
 for reportlab/graphics.  For now they are contrived, but we will expand them
 to try and trip up any parser. Feel free to add more.
 
@@ -291,4 +293,4 @@
 
 
 if __name__=='__main__':
-    print __doc__
\ No newline at end of file
+    print __doc__
--- a/src/reportlab/graphics/testshapes.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/testshapes.py	Fri Dec 12 17:55:22 2008 +0000
@@ -5,17 +5,15 @@
 
 # testshapes.py - draws shapes onto a PDF canvas.
 
-"""
-Execute the script to see some test drawings.
+
+__version__ = ''' $Id $ '''
+__doc__='''Execute this script to see some test drawings.
 
 This contains a number of routines to generate test drawings
 for reportlab/graphics.  For now many of them are contrived,
 but we will expand them to try and trip up any parser.
 Feel free to add more.
-"""
-
-__version__ = ''' $Id $ '''
-
+'''
 
 import os, sys
 
--- a/src/reportlab/graphics/widgetbase.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/widgetbase.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,6 +2,8 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/widgetbase.py
 __version__=''' $Id$ '''
+__doc__='''Base class for user-defined graphical widgets'''
+
 import string
 
 from reportlab.graphics import shapes
--- a/src/reportlab/graphics/widgets/__init__.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/widgets/__init__.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,4 +1,5 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/widgets/__init__.py
-__version__=''' $Id$ '''
\ No newline at end of file
+__version__=''' $Id$ '''
+__doc__='''Some non-chart widgets'''
--- a/src/reportlab/graphics/widgets/eventcal.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/widgets/eventcal.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,9 +2,10 @@
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/widgets/eventcal.py
 # Event Calendar widget
 # author: Andy Robinson
-"""This file is a
+
+__version__=''' $Id$ '''
+__doc__="""This file is a
 """
-__version__=''' $Id$ '''
 
 from reportlab.lib import colors
 from reportlab.lib.validators import *
--- a/src/reportlab/graphics/widgets/flags.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/widgets/flags.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,7 +2,9 @@
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/widgets/flags.py
 # Flag Widgets - a collection of flags as widgets
 # author: John Precedo (johnp@reportlab.com)
-"""This file is a collection of flag graphics as widgets.
+
+__version__=''' $Id$ '''
+__doc__="""This file is a collection of flag graphics as widgets.
 
 All flags are represented at the ratio of 1:2, even where the official ratio for the flag is something else
 (such as 3:5 for the German national flag). The only exceptions are for where this would look _very_ wrong,
@@ -27,7 +29,6 @@
 
 (Brazilian flag contributed by Publio da Costa Melo [publio@planetarium.com.br]).
 """
-__version__=''' $Id$ '''
 
 from reportlab.lib import colors
 from reportlab.lib.validators import *
--- a/src/reportlab/graphics/widgets/markers.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/widgets/markers.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,10 +1,11 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/graphics/widgets/markers.py
+
+__version__=''' $Id$ '''
+__doc__="""This modules defines a collection of markers used in charts.
 """
-This modules defines a collection of markers used in charts.
-"""
-__version__=''' $Id$ '''
+
 from types import FunctionType, ClassType
 from reportlab.graphics.shapes import Rect, Line, Circle, Polygon, Drawing, Group
 from reportlab.graphics.widgets.signsandsymbols import SmileyFace
--- a/src/reportlab/graphics/widgets/signsandsymbols.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/graphics/widgets/signsandsymbols.py	Fri Dec 12 17:55:22 2008 +0000
@@ -4,9 +4,12 @@
 # signsandsymbols.py
 # A collection of new widgets
 # author: John Precedo (johnp@reportlab.com)
-"""This file is a collection of widgets to produce some common signs and symbols.
+
+__version__=''' $Id$ '''
+__doc__="""This file is a collection of widgets to produce some common signs and symbols.
 
 Widgets include:
+
 - ETriangle (an equilateral triangle),
 - RTriangle (a right angled triangle),
 - Octagon,
@@ -23,7 +26,6 @@
 - ArrowOne, and
 - ArrowTwo
 """
-__version__=''' $Id$ '''
 
 from reportlab.lib import colors
 from reportlab.lib.validators import *
@@ -916,4 +918,4 @@
     print 'wrote file: signsandsymbols.pdf'
 
 if __name__=='__main__':
-    test()
\ No newline at end of file
+    test()
--- a/src/reportlab/pdfbase/__init__.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/pdfbase/__init__.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,5 +2,5 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/pdfbase/__init__.py
 __version__=''' $Id$ '''
-__doc__="""
-"""
\ No newline at end of file
+__doc__="""Internal functionality for creating PDF files - not part of API
+"""
--- a/src/reportlab/pdfbase/_can_cmap_data.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/pdfbase/_can_cmap_data.py	Fri Dec 12 17:55:22 2008 +0000
@@ -6,14 +6,15 @@
 font.  we just want a dictionary of the character widths in a given
 font which are NOT 1000 ems wide, keyed on Unicode character (not CID).
 
-Running off CMAP files we get the following widths...
->>> font.stringWidth(unicode(','), 10)
-2.5
->>> font.stringWidth(unicode('m'), 10)
-7.7800000000000002
->>> font.stringWidth(u'\u6771\u4EAC', 10)
-20.0
->>> 
+Running off CMAP files we get the following widths...::
+
+    >>> font.stringWidth(unicode(','), 10)
+    2.5
+    >>> font.stringWidth(unicode('m'), 10)
+    7.7800000000000002
+    >>> font.stringWidth(u'\u6771\u4EAC', 10)
+    20.0
+    >>> 
 
 """
 
@@ -55,4 +56,4 @@
 
 if __name__=='__main__':
     run()
-    
\ No newline at end of file
+    
--- a/src/reportlab/pdfbase/_fontdata.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/pdfbase/_fontdata.py	Fri Dec 12 17:55:22 2008 +0000
@@ -3,17 +3,14 @@
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/pdfbase/_fontdata.py
 #$Header $
 __version__=''' $Id$ '''
-__doc__="""
+__doc__="""Database of font related things
 
-        database of font related things::
-        
-            standardFonts       tuple of the 14 standard string font names
-            standardEncodings   tuple of the known standard font names
-            encodings           a mapping object from standard encoding names (and minor variants)
-                                to the encoding vectors ie the tuple of string glyph names
-            widthsByFontGlyph   fontname x glyphname --> width of glyph
-            widthVectorsByFont  fontName -> vector of widths
-        
+    - standardFonts - tuple of the 14 standard string font names
+    - standardEncodings - tuple of the known standard font names
+    - encodings - a mapping object from standard encoding names (and minor variants)
+      to the encoding vectors ie the tuple of string glyph names
+    - widthsByFontGlyph - fontname x glyphname --> width of glyph
+    - widthVectorsByFont - fontName -> vector of widths 
 """
 import UserDict, os, sys
 
--- a/src/reportlab/pdfbase/pdfmetrics.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/pdfbase/pdfmetrics.py	Fri Dec 12 17:55:22 2008 +0000
@@ -3,8 +3,7 @@
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/pdfbase/pdfmetrics.py
 #$Header $
 __version__=''' $Id$ '''
-__doc__="""
-This provides a database of font metric information and
+__doc__="""This provides a database of font metric information and
 efines Font, Encoding and TypeFace classes aimed at end users.
 
 There are counterparts to some of these in pdfbase/pdfdoc.py, but
--- a/src/reportlab/pdfbase/pdfpattern.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/pdfbase/pdfpattern.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,5 +1,4 @@
-"""
-helper for importing pdf structures into a ReportLab generated document
+__doc__="""helper for importing pdf structures into a ReportLab generated document
 """
 from reportlab.pdfbase.pdfdoc import format
 
--- a/src/reportlab/pdfbase/ttfonts.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/pdfbase/ttfonts.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,7 +1,8 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/pdfbase/ttfonts.py
-"""TrueType font support
+__version__ = '$Id$'
+__doc__="""TrueType font support
 
 This defines classes to represent TrueType fonts.  They know how to calculate
 their own width and how to write themselves into PDF files.  They support
@@ -18,7 +19,7 @@
 To support dynamic font subsetting a concept of "dynamic font" was introduced.
 Dynamic Fonts have a _dynamicFont attribute set to 1.
 
-Dynamic fonts have the following additional functions:
+Dynamic fonts have the following additional functions::
 
     def splitString(self, text, doc):
         '''Splits text into a number of chunks, each of which belongs to a
@@ -35,11 +36,11 @@
 You must never call PDFDocument.getInternalFontName for dynamic fonts.
 
 If you have a traditional static font, mapping to PDF text output operators
-is simple:
+is simple::
 
    '%s 14 Tf (%s) Tj' % (getInternalFontName(psfontname), text)
 
-If you have a dynamic font, use this instead:
+If you have a dynamic font, use this instead::
 
    for subset, chunk in font.splitString(text, doc):
        '%s 14 Tf (%s) Tj' % (font.getSubsetInternalName(subset, doc), chunk)
@@ -51,8 +52,6 @@
 Canvas and TextObject have special support for dynamic fonts.
 """
 
-__version__ = '$Id$'
-
 import string
 from types import StringType, UnicodeType
 from struct import pack, unpack
--- a/src/reportlab/pdfgen/__init__.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/pdfgen/__init__.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,4 +2,4 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/pdfgen/__init__.py
 __version__=''' $Id$ '''
-__doc__=''
\ No newline at end of file
+__doc__='''Defines a high-level Canvas interface for creating PDF files'''
--- a/src/reportlab/pdfgen/pycanvas.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/pdfgen/pycanvas.py	Fri Dec 12 17:55:22 2008 +0000
@@ -4,7 +4,7 @@
 #
 # $Id$
 #
-__doc__ = """pycanvas.Canvas : a Canvas class which can also output Python source code.
+__doc__ = """A contributed Canvas class which can also output Python source code to "replay" operations later
 
 pycanvas.Canvas class works exactly like canvas.Canvas, but you can
 call str() on pycanvas.Canvas instances. Doing so will return the
--- a/src/reportlab/platypus/__init__.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/platypus/__init__.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,7 +2,8 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/platypus/__init__.py
 __version__=''' $Id$ '''
-__doc__=''
+__doc__='''Page Layout and Typography Using Scripts" - higher-level framework for flowing documents'''
+
 from reportlab.platypus.flowables import Flowable, Image, Macro, PageBreak, Preformatted, Spacer, XBox, \
                         CondPageBreak, KeepTogether, TraceInfo, FailOnWrap, FailOnDraw, PTOContainer, \
                         KeepInFrame, ParagraphAndImage, ImageAndFlowables
--- a/src/reportlab/platypus/frames.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/platypus/frames.py	Fri Dec 12 17:55:22 2008 +0000
@@ -4,7 +4,7 @@
 
 __version__=''' $Id$ '''
 
-__doc__="""
+__doc__="""A frame is a container for content on a page.
 """
 
 import logging
--- a/src/reportlab/platypus/paragraph.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/platypus/paragraph.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,6 +2,7 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/platypus/paragraph.py
 __version__=''' $Id$ '''
+__doc__='''The standard paragraph implementation'''
 from string import join, whitespace
 from operator import truth
 from types import StringType, ListType
--- a/src/reportlab/platypus/paraparser.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/platypus/paraparser.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,6 +2,7 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/platypus/paraparser.py
 __version__=''' $Id$ '''
+__doc__='''The parser used to process markup within paragraphs'''
 import string
 import re
 from types import TupleType, UnicodeType, StringType
--- a/src/reportlab/platypus/tableofcontents.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/platypus/tableofcontents.py	Fri Dec 12 17:55:22 2008 +0000
@@ -1,7 +1,10 @@
 #Copyright ReportLab Europe Ltd. 2000-2004
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/platypus/tableofcontents.py
-"""
+
+__version__=''' $Id$ '''
+__doc__="""Experimental class to generate Tables of Contents easily
+
 This module defines a single TableOfContents() class that can be used to
 create automatically a table of tontents for Platypus documents like
 this:
@@ -32,7 +35,7 @@
 lines after the first are indented by the same constant named
 epsilon.
 """
-__version__=''' $Id$ '''
+
 import string
 
 from reportlab.lib import enums
--- a/src/reportlab/platypus/xpreformatted.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/platypus/xpreformatted.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,6 +2,7 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/platypus/xpreformatted.py
 __version__=''' $Id$ '''
+__doc__='''A 'rich preformatted text' widget allowing internal markup'''
 import string
 from types import StringType, ListType
 from reportlab.lib import PyFontify
--- a/src/reportlab/rl_config.py	Fri Dec 12 17:01:47 2008 +0000
+++ b/src/reportlab/rl_config.py	Fri Dec 12 17:55:22 2008 +0000
@@ -2,6 +2,7 @@
 #see license.txt for license details
 #history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/rl_config.py
 __version__=''' $Id$ '''
+__doc__='''Configuration file.  You may edit this if you wish.'''
 
 allowTableBoundsErrors =    1 # set to 0 to die on too large elements in tables in debug (recommend 1 for production use)
 shapeChecking =             1