Changeset 208 in tracdarcs

Timestamp:

07/30/10 23:21:00 (3 years ago)

Author:

lele@…

Hash name:

20100730212100-97f81-07672b3a09a717eded77354cad2fb5e799cba4c6

Message:

Docstrings

Location:

tracdarcs

Files:

• components.py (modified) (5 diffs)
• repository.py (modified) (4 diffs)

tracdarcs/components.py

@@ -31 +31 @@
 
 class DarcsConnector(Component):
+    """Provide access to a darcs repository."""
 
     implements(IRepositoryConnector, IWikiSyntaxProvider)
@@ -128 +129 @@
 
 class DarcsSetup(Component):
-    """Darcs customizer.
-
-    The db tables required for the darcs backend are created here.
-    """
+    """Setup darcs specific database tables."""
 
     implements(IAdminCommandProvider, IEnvironmentSetupParticipant)
@@ -144 +142 @@
 
     def environment_needs_upgrade(self, db):
-        """Check to see if the darcs tables are already there."""
+        """Check to see if the darcs tables are already there, or need upgrade."""
 
         c = db.cursor()
@@ -294 +292 @@
 
 class EquivalentChangesetsRenderer(Component):
+    """Handle the `PresentIn` changesets property."""
+
     implements(IPropertyRenderer)
 
@@ -312 +312 @@
 
 class MissingInReposRenderer(Component):
+    """Handle the `MissingIn` changesets property."""
+
     implements(IPropertyRenderer)
 

tracdarcs/repository.py

@@ -58 +58 @@
 
 class DarcsRepository(Repository):
+    """Implement the IRepository interface for a darcs repository."""
+
     def __init__(self, db, path, log, darcscmd, possible_encodings,
                  params, eager_annotations):
@@ -262 +264 @@
 
 class DarcsNode(Node):
+    """Implement darcs specific logic around a ``Node``."""
+
     def __init__(self, node_id, node_type, path, rev,
                  repos, cmd, log=None):
@@ -571 +575 @@
 
 class DarcsChangeset(Changeset):
+    """Represent a cached darcs changeset."""
+
     def __init__(self, repos, rev):
         repo_id = repos.id
@@ -605 +611 @@
         repo_id = self.repos.id
         c.execute('SELECT node_id,path,change_kind FROM darcs_node_changes '
-                   'WHERE repo_id = %s AND rev = %s', (repo_id, self.rev,))
+                  'WHERE repo_id = %s AND rev = %s', (repo_id, self.rev,))
         for node_id,path,change in c:
             node_type = get_node_type(self.repos.db, repo_id, node_id)