Add more documentation for the API.
author |
Steve Losh <steve@stevelosh.com> |
date |
Thu, 08 Oct 2009 18:23:23 -0400 |
parents |
f8233e2ca199
|
children |
9df20fad6514
|
branches/tags |
(none) |
files |
review/api.py |
Changes
--- 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: