From: Skip Montanaro <skip@pobox.com>
Date: Wed, 5 Jan 2005 06:54:58 +0000 (+0000)
Subject: add a couple missing docstrings
X-Git-Tag: v2.5a0~2183
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f26285ce0be666da5566f1b9be80bba6bbf1d537;p=python

add a couple missing docstrings
---

diff --git a/Lib/csv.py b/Lib/csv.py
index f2389fd304..78b675949e 100644
--- a/Lib/csv.py
+++ b/Lib/csv.py
@@ -20,6 +20,13 @@ __all__ = [ "QUOTE_MINIMAL", "QUOTE_ALL", "QUOTE_NONNUMERIC", "QUOTE_NONE",
             "unregister_dialect", "__version__", "DictReader", "DictWriter" ]
 
 class Dialect:
+    """Describe an Excel dialect.
+
+    This must be subclassed (see csv.excel).  Valid attributes are:
+    delimiter, quotechar, escapechar, doublequote, skipinitialspace,
+    lineterminator, quoting.
+
+    """
     _name = ""
     _valid = False
     # placeholders
@@ -78,6 +85,7 @@ class Dialect:
         return errors
 
 class excel(Dialect):
+    """Describe the usual properties of Excel-generated CSV files."""
     delimiter = ','
     quotechar = '"'
     doublequote = True
@@ -87,6 +95,7 @@ class excel(Dialect):
 register_dialect("excel", excel)
 
 class excel_tab(excel):
+    """Describe the usual properties of Excel-generated TAB-delimited files."""
     delimiter = '\t'
 register_dialect("excel-tab", excel_tab)