Added docs for the error module

Byron · Byron · commit 451561c25232 · 2009-10-08T17:29:52.000+02:00
diff --git a/lib/git/cmd.py b/lib/git/cmd.py
@@ -102,7 +102,10 @@ def execute(self, command,
         
          str(output)                                  # extended_output = False (Default)
          tuple(int(status), str(stdout), str(stderr)) # extended_output = True
-         
+        
+        Raise
+        	GitCommandError
+        
         NOTE
            If you add additional keyword arguments to the signature of this method, 
            you must update the execute_kwargs tuple housed in this module.
diff --git a/lib/git/errors.py b/lib/git/errors.py
@@ -3,14 +3,24 @@
 #
 # This module is part of GitPython and is released under
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
+"""
+Module containing all exceptions thrown througout the git package,
+"""
 
 class InvalidGitRepositoryError(Exception):
-    pass
+    """
+    Thrown if the given repository appears to have an invalid format. 
+    """
 
 class NoSuchPathError(Exception):
-    pass
+    """
+    Thrown if a path could not be access by the system.
+    """
 
 class GitCommandError(Exception):
+    """
+    Thrown if execution of the git command fails with non-zero status code.
+    """
     def __init__(self, command, status, stderr=None):
         self.stderr = stderr
         self.status = status
