Skip to content

Commit f51fe3e

Browse files
committed
Added previously missing parameter documentation for Repo.__init__ .
Related to gitpython-developers#255
1 parent 28d6c90 commit f51fe3e

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

git/repo/base.py

+5
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,11 @@ def __init__(self, path=None, odbt=DefaultDBType, search_parent_directories=Fals
121121
Object DataBase type - a type which is constructed by providing
122122
the directory containing the database objects, i.e. .git/objects. It will
123123
be used to access all object data
124+
:param search_parent_directories:
125+
if True, all parent directories will be searched for a valid repo as well.
126+
127+
Please note that this was the default behaviour in older versions of GitPython,
128+
which is considered a bug though.
124129
:raise InvalidGitRepositoryError:
125130
:raise NoSuchPathError:
126131
:return: git.Repo """

0 commit comments

Comments
 (0)