[SQL-CVS] r4315 - SQLObject/trunk/docs

[<sub...@co...>]

Author: phd
Date: Fri Dec 24 05:58:41 2010
New Revision: 4315

Log:
Documented required and optional parameters.

Modified:
   SQLObject/trunk/docs/SQLBuilder.txt

Modified: SQLObject/trunk/docs/SQLBuilder.txt
==============================================================================
--- SQLObject/trunk/docs/SQLBuilder.txt	Fri Dec 24 05:55:32 2010	(r4314)
+++ SQLObject/trunk/docs/SQLBuilder.txt	Fri Dec 24 05:58:41 2010	(r4315)
@@ -145,7 +145,7 @@
 Use connection.query(query) to execute the query.
 
 `table`:
-   A string that names the table to INSERT into.
+   A string that names the table to INSERT into. Required.
 
 `valueList`:
    A list of (key, value) sequences or {key: value} dictionaries; keys
@@ -181,13 +181,13 @@
 Use connection.query(query) to execute the query.
 
 `table`:
-   A string that names the table to UPDATE.
+   A string that names the table to UPDATE. Required.
 
 `values`:
-   A dictionary {key: value}; keys are column names.
+   A dictionary {key: value}; keys are column names. Required.
 
 `where`:
-   A string or an SQLExpression, represents the WHERE clause.
+   An optional string or an SQLExpression, represents the WHERE clause.
 
 Example::
 
@@ -204,10 +204,12 @@
 Use connection.query(query) to execute the query.
 
 `table`:
-   A string that names the table to UPDATE.
+   A string that names the table to UPDATE. Required.
 
 `where`:
-   A string or an SQLExpression, represents the WHERE clause.
+   A string or an SQLExpression, represents the WHERE clause. Required.
+   If you need to delete all rows pass ``where=None``; this is a safety
+   measure.
 
 Example::