From 977eff5af10b50ba6e6edb6abc4f40804c418b12 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@drexel.edu>
Date: Sun, 7 Feb 2010 17:53:53 -0500
Subject: Fixed docstrings so only Sphinx errors are "autosummary" and "missing
 attribute"

---
 libbe/storage/vcs/hg.py | 86 ++++++++++++++++++++++++++-----------------------
 1 file changed, 46 insertions(+), 40 deletions(-)

(limited to 'libbe/storage/vcs/hg.py')

diff --git a/libbe/storage/vcs/hg.py b/libbe/storage/vcs/hg.py
index 97fc470..9378336 100644
--- a/libbe/storage/vcs/hg.py
+++ b/libbe/storage/vcs/hg.py
@@ -17,8 +17,9 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
-"""
-Mercurial (hg) backend.
+"""Mercurial_ (hg) backend.
+
+.. _Mercurial: http://mercurial.selenic.com/
 """
 
 try:
@@ -58,6 +59,8 @@ def new():
     return Hg()
 
 class Hg(base.VCS):
+    """:class:`base.VCS` implementation for Mercurial.
+    """
     name='hg'
     client=None # mercurial module
 
@@ -177,45 +180,48 @@ class Hg(base.VCS):
             'diff', '-r', revision, '--git')
 
     def _parse_diff(self, diff_text):
-        """
-        Example diff text:
+        """_parse_diff(diff_text) -> (new,modified,removed)
+
+        `new`, `modified`, and `removed` are lists of files.
+
+        Example diff text::
                 
-        diff --git a/.be/dir/bugs/modified b/.be/dir/bugs/modified
-        --- a/.be/dir/bugs/modified
-        +++ b/.be/dir/bugs/modified
-        @@ -1,1 +1,1 @@ some value to be modified
-        -some value to be modified
-        \ No newline at end of file
-        +a new value
-        \ No newline at end of file
-        diff --git a/.be/dir/bugs/moved b/.be/dir/bugs/moved
-        deleted file mode 100644
-        --- a/.be/dir/bugs/moved
-        +++ /dev/null
-        @@ -1,1 +0,0 @@
-        -this entry will be moved
-        \ No newline at end of file
-        diff --git a/.be/dir/bugs/moved2 b/.be/dir/bugs/moved2
-        new file mode 100644
-        --- /dev/null
-        +++ b/.be/dir/bugs/moved2
-        @@ -0,0 +1,1 @@
-        +this entry will be moved
-        \ No newline at end of file
-        diff --git a/.be/dir/bugs/new b/.be/dir/bugs/new
-        new file mode 100644
-        --- /dev/null
-        +++ b/.be/dir/bugs/new
-        @@ -0,0 +1,1 @@
-        +this entry is new
-        \ No newline at end of file
-        diff --git a/.be/dir/bugs/removed b/.be/dir/bugs/removed
-        deleted file mode 100644
-        --- a/.be/dir/bugs/removed
-        +++ /dev/null
-        @@ -1,1 +0,0 @@
-        -this entry will be deleted
-        \ No newline at end of file
+          diff --git a/.be/dir/bugs/modified b/.be/dir/bugs/modified
+          --- a/.be/dir/bugs/modified
+          +++ b/.be/dir/bugs/modified
+          @@ -1,1 +1,1 @@ some value to be modified
+          -some value to be modified
+          \ No newline at end of file
+          +a new value
+          \ No newline at end of file
+          diff --git a/.be/dir/bugs/moved b/.be/dir/bugs/moved
+          deleted file mode 100644
+          --- a/.be/dir/bugs/moved
+          +++ /dev/null
+          @@ -1,1 +0,0 @@
+          -this entry will be moved
+          \ No newline at end of file
+          diff --git a/.be/dir/bugs/moved2 b/.be/dir/bugs/moved2
+          new file mode 100644
+          --- /dev/null
+          +++ b/.be/dir/bugs/moved2
+          @@ -0,0 +1,1 @@
+          +this entry will be moved
+          \ No newline at end of file
+          diff --git a/.be/dir/bugs/new b/.be/dir/bugs/new
+          new file mode 100644
+          --- /dev/null
+          +++ b/.be/dir/bugs/new
+          @@ -0,0 +1,1 @@
+          +this entry is new
+          \ No newline at end of file
+          diff --git a/.be/dir/bugs/removed b/.be/dir/bugs/removed
+          deleted file mode 100644
+          --- a/.be/dir/bugs/removed
+          +++ /dev/null
+          @@ -1,1 +0,0 @@
+          -this entry will be deleted
+          \ No newline at end of file
         """
         new = []
         modified = []
-- 
cgit