From 1f66cfbbce58b4b552b041707a12d437cc5f400a Mon Sep 17 00:00:00 2001
From: Michael Trier <mtrier@gmail.com>
Date: Wed, 7 May 2008 20:47:35 -0400
Subject: just more documentation fixes.

---
 lib/git_python/diff.py |  4 ++++
 lib/git_python/git.py  | 11 ++++++++++-
 lib/git_python/repo.py |  2 +-
 3 files changed, 15 insertions(+), 2 deletions(-)

(limited to 'lib/git_python')

diff --git a/lib/git_python/diff.py b/lib/git_python/diff.py
index 9d2690be..185e1f57 100644
--- a/lib/git_python/diff.py
+++ b/lib/git_python/diff.py
@@ -2,6 +2,10 @@ import re
 import commit
 
 class Diff(object):
+    """
+    A Diff contains diff information between two commits.
+    """
+    
     def __init__(self, repo, a_path, b_path, a_commit, b_commit, a_mode, b_mode, new_file, deleted_file, diff):
         self.repo = repo
         self.a_path = a_path
diff --git a/lib/git_python/git.py b/lib/git_python/git.py
index 4bc8760a..4d7063f4 100644
--- a/lib/git_python/git.py
+++ b/lib/git_python/git.py
@@ -5,6 +5,9 @@ from utils import *
 from method_missing import MethodMissingMixin
 
 class Git(MethodMissingMixin):
+    """
+    The Git class manages communication with the Git binary
+    """
     def __init__(self, git_dir):
         super(Git, self).__init__()
         self.git_dir = git_dir
@@ -16,7 +19,13 @@ class Git(MethodMissingMixin):
         return self.git_dir
         
     def execute(self, command):
-        print command
+        """
+        Handles executing the command on the shell and consumes and returns
+        the returned information (stdout)
+        
+        ``command``
+            The command to execute
+        """
         proc = subprocess.Popen(command, 
                                 shell=True,
                                 stdout=subprocess.PIPE,
diff --git a/lib/git_python/repo.py b/lib/git_python/repo.py
index a9bf30dd..20f60a3d 100644
--- a/lib/git_python/repo.py
+++ b/lib/git_python/repo.py
@@ -233,7 +233,7 @@ class Repo(object):
         ``paths``
             is an optional list of file paths on which to restrict the diff
         """
-        self.git.diff(a, b, '--', *paths)
+        return self.git.diff(a, b, '--', *paths)
 
     def commit_diff(self, commit):
         """
-- 
cgit v1.2.1