Commit451561c

committed

Added docs for the error module

1 parent2454ae8 commit451561cCopy full SHA for 451561c

File tree

+16

-3

lines changed

+16

-3

lines changed

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,10 @@ def execute(self, command,`
`102`	`102`
`103`	`103`	`str(output) # extended_output = False (Default)`
`104`	`104`	`tuple(int(status), str(stdout), str(stderr)) # extended_output = True`
`105`		`-`
	`105`	`+`
	`106`	`+ Raise`
	`107`	`+ GitCommandError`
	`108`	`+`
`106`	`109`	`NOTE`
`107`	`110`	`If you add additional keyword arguments to the signature of this method,`
`108`	`111`	`you must update the execute_kwargs tuple housed in this module.`

Lines changed: 12 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -3,14 +3,24 @@`
`3`	`3`	`#`
`4`	`4`	`# This module is part of GitPython and is released under`
`5`	`5`	`# the BSD License: http://www.opensource.org/licenses/bsd-license.php`
	`6`	`+"""`
	`7`	`+Module containing all exceptions thrown througout the git package,`
	`8`	`+"""`
`6`	`9`
`7`	`10`	`classInvalidGitRepositoryError(Exception):`
`8`		`-pass`
	`11`	`+"""`
	`12`	`+ Thrown if the given repository appears to have an invalid format.`
	`13`	`+ """`
`9`	`14`
`10`	`15`	`classNoSuchPathError(Exception):`
`11`		`-pass`
	`16`	`+"""`
	`17`	`+ Thrown if a path could not be access by the system.`
	`18`	`+ """`
`12`	`19`
`13`	`20`	`classGitCommandError(Exception):`
	`21`	`+"""`
	`22`	`+ Thrown if execution of the git command fails with non-zero status code.`
	`23`	`+ """`
`14`	`24`	`def__init__(self,command,status,stderr=None):`
`15`	`25`	`self.stderr=stderr`
`16`	`26`	`self.status=status`

Comments

(0)