From 451561c252323e74696dbe0be36601c95a75a8c3 Mon Sep 17 00:00:00 2001
From: Sebastian Thiel <byronimo@gmail.com>
Date: Thu, 8 Oct 2009 17:29:52 +0200
Subject: Added docs for the error module

---
 lib/git/errors.py | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

(limited to 'lib/git/errors.py')

diff --git a/lib/git/errors.py b/lib/git/errors.py
index bf882d33..2632d5f3 100644
--- 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
-- 
cgit v1.2.1