diff options
author | Sebastian Thiel <byronimo@gmail.com> | 2015-01-14 17:47:44 +0100 |
---|---|---|
committer | Sebastian Thiel <byronimo@gmail.com> | 2015-01-14 17:49:33 +0100 |
commit | 6569c4849197c9475d85d05205c55e9ef28950c1 (patch) | |
tree | 3dfb25f7c23a74e466e43ab6db87eeb4290712a7 /git/util.py | |
parent | 53e5fb3733e491925a01e9da6243e93c2e4214c1 (diff) | |
download | gitpython-6569c4849197c9475d85d05205c55e9ef28950c1.tar.gz |
Fixed some doc strings to build correctly with sphinx
Fixes #7
[ci skip]
Diffstat (limited to 'git/util.py')
-rw-r--r-- | git/util.py | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/git/util.py b/git/util.py index b1f3b38d..010130cb 100644 --- a/git/util.py +++ b/git/util.py @@ -40,6 +40,7 @@ __all__ = ("stream_copy", "join_path", "to_native_path_windows", "to_native_path def rmtree(path): """Remove the given recursively. + :note: we use shutil rmtree but adjust its behaviour to see whether files that couldn't be deleted are read-only. Windows will not remove them in that case""" def onerror(func, path, exc_info): @@ -251,8 +252,10 @@ class RemoteProgress(object): return failed_lines def new_message_handler(self): - """:return: a progress handler suitable for handle_process_output(), passing lines on to this Progress - handler in a suitable format""" + """ + :return: + a progress handler suitable for handle_process_output(), passing lines on to this Progress + handler in a suitable format""" def handler(line): return self._parse_progress_line(line.rstrip()) # end |