Merge lp:~tristan-rivoallan/trac-errorcollectionplugin/devel into lp:trac-errorcollectionplugin

[Tristan Rivoallan]

Enhanced documentation in db.py

[Tristan Rivoallan (tristan-rivoallan)]

review: Approve

=== modified file 'errorcollectionplugin/db.py'
--- errorcollectionplugin/db.py	2010-03-10 14:25:29 +0000
+++ errorcollectionplugin/db.py	2010-03-10 16:21:19 +0000
@@ -30,19 +30,21 @@
 # Create tables
 
 def to_sql(env, table):
+    """Converts a trac.db.schema specification to SQL compatible with database manager driver"""
     from trac.db.api import DatabaseManager
     dataManager = env.components[DatabaseManager]
     dc = dataManager._get_connector()[0]
     return dc.to_sql(table)
 
 def create_tables(env, db):
+    """Creates schema in database"""
     cursor = db.cursor()
     for table in schema:
         for stmt in to_sql(env, table):
             cursor.execute(stmt)
-    #As execute expect a sequence or a tuple
-    #http://docs.python.org/library/sqlite3.html
-    #http://stackoverflow.com/questions/228912/sqlite-parameter-substitution-problem
+    # As execute expect a sequence or a tuple
+    # http://docs.python.org/library/sqlite3.html
+    # http://stackoverflow.com/questions/228912/sqlite-parameter-substitution-problem
     cursor.execute("INSERT into system values ('errorcollection_version', %s)", (str(db_version),));
 
 # Upgrades
@@ -74,6 +76,7 @@
                            (str(db_version),))
 
     def _get_version(self, db):
+       """Returns currently installed database schema version"""
         cursor = db.cursor()
         try:
             sql = "SELECT value FROM system WHERE name='errorcollection_version'"