# HG changeset patch
# User Steve Losh <steve@stevelosh.com>
# Date 1255040603 14400
# Node ID 21e11e7dfca56d31e6d5f4426d072cb56e8289f1
# Parent  f8233e2ca199fd59088b55384218927b7eef1361
Add more documentation for the API.

diff -r f8233e2ca199 -r 21e11e7dfca5 review/api.py
--- a/review/api.py	Thu Oct 08 18:16:08 2009 -0400
+++ b/review/api.py	Thu Oct 08 18:23:23 2009 -0400
@@ -121,6 +121,21 @@
 class ReviewDatastore(object):
     """The code review data for a particular repository."""
     def __init__(self, ui, repo, lpath=None, rpath=None, create=False):
+        """Initialize a ReviewDatastore for a Mercurial repository.
+        
+        To get a ReviewDatastore for a repository that has already been
+        initialized for code reviewing:
+        
+            review_data = ReviewDatastore(ui, repo)
+        
+        To set up a repository to support code review:
+        
+            review_data = ReviewDatastore(ui, repo, create=True)
+        
+        Error handling is a bit tricky at the moment.  I need to refactor
+        and/or document this.
+        
+        """
         self.ui = ui
         
         if not create: