]> granicus.if.org Git - python/commitdiff
#1825: correctly document msilib.add_data.
authorGeorg Brandl <georg@python.org>
Sat, 23 Feb 2008 22:55:18 +0000 (22:55 +0000)
committerGeorg Brandl <georg@python.org>
Sat, 23 Feb 2008 22:55:18 +0000 (22:55 +0000)
Doc/library/msilib.rst

index 193ac3b9b0dc20c7ab174afd4a1bf60b4d252824..c6054732e159a15f3b3d178f9e82664e4b34824b 100644 (file)
@@ -67,7 +67,7 @@ structures.
 
 .. function:: init_database(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer)
 
-   Create and return a new database *name*, initialize it  with *schema*,  and set
+   Create and return a new database *name*, initialize it with *schema*, and set
    the properties *ProductName*, *ProductCode*, *ProductVersion*, and
    *Manufacturer*.
 
@@ -79,11 +79,17 @@ structures.
    function returns.
 
 
-.. function:: add_data(database, records)
+.. function:: add_data(database, table, records)
 
-   Add all *records* to *database*.  *records* should be a list of tuples, each one
-   containing all fields of a record according to the schema of the table.  For
-   optional fields, ``None`` can be passed.
+   Add all *records* to the table named *table* in *database*.
+
+   The *table* argument must be one of the predefined tables in the MSI schema,
+   e.g. ``'Feature'``, ``'File'``, ``'Component'``, ``'Dialog'``, ``'Control'``,
+   etc.
+
+   *records* should be a list of tuples, each one containing all fields of a
+   record according to the schema of the table.  For optional fields,
+   ``None`` can be passed.
 
    Field values can be int or long numbers, strings, or instances of the Binary
    class.