# HG changeset patch
# User Steve Losh <steve@stevelosh.com>
# Date 1255039137 14400
# Node ID cc9456bb289bb9e2e41463ee08692861217c6f9b
# Parent  8cea29aa955f400f34e10e5b390d9735271ff0ba
Add more API documentation.

diff -r 8cea29aa955f -r cc9456bb289b review/api.py
--- a/review/api.py	Thu Oct 08 17:52:54 2009 -0400
+++ b/review/api.py	Thu Oct 08 17:58:57 2009 -0400
@@ -119,7 +119,7 @@
 
 
 class ReviewDatastore(object):
-    """The data store for all the reviews so far."""
+    """The code review data for a particular repository."""
     def __init__(self, ui, repo, lpath=None, rpath=None, create=False):
         self.ui = ui
         
@@ -155,6 +155,15 @@
 class ReviewChangeset(object):
     """The review data about one changeset in the target repository."""
     def __init__(self, ui, repo, target, node):
+        """A changeset being reviewed.
+        
+        You shouldn't need to create these directly -- use a ReviewDatastore
+        object to get them:
+        
+            review_data = ReviewDatastore(ui, repo)
+            tip_review_data = review_data['tip']
+        
+        """
         self.repo = repo
         self.target = target
         self.ui = ui
@@ -290,7 +299,7 @@
     
 
 class _ReviewObject(object):
-    """Some kind of object."""
+    """A base object for some kind of review data (a signoff or comment)."""
     def __init__(self, container, commit_message, delete_message=None):
         self.container = container
         self.commit_message = commit_message