Rev 74: Add pydoctor file, more docstrings. in file:///data/jelmer/bzr-rebase/trunk/

[Jelmer Vernooij]

At file:///data/jelmer/bzr-rebase/trunk/

------------------------------------------------------------
revno: 74
revision-id:jelmer at samba.org-20071221192154-dcqjl6a4e77m9aja
parent: jelmer at samba.org-20071221182006-sfg466t25im7b58z
committer: Jelmer Vernooij <jelmer at samba.org>
branch nick: trunk
timestamp: Fri 2007-12-21 20:21:54 +0100
message:
  Add pydoctor file, more docstrings.
added:
  bzr-rebase.cfg                 bzrrebase.cfg-20071221182820-jjha8mvkad81sw8j-1
modified:
  .bzrignore                     bzrignore-20070717161544-milabznvp713c9yo-1
  __init__.py                    __init__.py-20070626215909-fi0s39bkwxn4gcto-1
  rebase.py                      rebase.py-20070626221123-ellanmf93nw8z9r1-1
=== added file 'bzr-rebase.cfg'
--- a/bzr-rebase.cfg	1970-01-01 00:00:00 +0000
+++ b/bzr-rebase.cfg	2007-12-21 19:21:54 +0000
@@ -0,0 +1,6 @@
+packages: .
+docformat: restructuredtext
+projectname: bzr-rebase
+projecturl: http://bazaar-vcs.org/Rebase
+htmloutput: apidocs
+prependedpackage: bzrlib.plugins.rebase

=== modified file '.bzrignore'
--- a/.bzrignore	2007-07-25 18:02:00 +0000
+++ b/.bzrignore	2007-12-21 19:21:54 +0000
@@ -1,2 +1,3 @@
 build
 tags
+apidocs

=== modified file '__init__.py'
--- a/__init__.py	2007-12-06 15:41:50 +0000
+++ b/__init__.py	2007-12-21 19:21:54 +0000
@@ -40,6 +40,8 @@
 def check_bzrlib_version(desired):
     """Check that bzrlib is compatible.
 
+    :param desired: Desired version.
+
     If version is < all compatible version, assume incompatible.
     """
     import bzrlib
@@ -56,6 +58,12 @@
 check_bzrlib_version(min_compatible_bzr_version)
 
 def find_last_common_revid(revhistory1, revhistory2):
+    """Find the last revision two revision histories have in common.
+
+    :param revhistory1: First revision history (list of revids)
+    :param revhistory2: First revision history (list of revids)
+    :return: The last common revision id
+    """
     for revid in reversed(revhistory1):
         if revid in revhistory2:
             return revid
@@ -354,6 +362,7 @@
 
 
 def test_suite():
+    """Determine the testsuite for bzr-rebase."""
     from unittest import TestSuite
     from bzrlib.tests import TestUtil
 

=== modified file 'rebase.py'
--- a/rebase.py	2007-10-23 20:04:42 +0000
+++ b/rebase.py	2007-12-21 19:21:54 +0000
@@ -384,6 +384,15 @@
 
 
 def replay_determine_base(graph, oldrevid, oldparents, newrevid, newparents):
+    """Determine the base for replaying a revision using merge.
+
+    :param graph: Revision graph.
+    :param oldrevid: Revid of old revision.
+    :param oldparents: List of old parents revids.
+    :param newrevid: Revid of new revision.
+    :param newparents: List of new parents revids.
+    :return: Revision id of the new new revision.
+    """
     # If this was the first commit, no base is needed
     if len(oldparents) == 0:
         return NULL_REVISION
@@ -508,6 +517,7 @@
 
 
 class ReplaySnapshotError(BzrError):
+    """Raised when replaying a snapshot failed."""
     _fmt = """Replaying the snapshot failed: %(message)s."""
 
     def __init__(self, message):
@@ -516,6 +526,7 @@
 
 
 class ReplayParentsInconsistent(BzrError):
+    """Raised when parents were inconsistent."""
     _fmt = """Parents were inconsistent while replaying commit for file id %(fileid)s, revision %(revid)s."""
 
     def __init__(self, fileid, revid):