diff options
| author | Kian Cross <kian@kiancross.co.uk> | 2020-07-13 15:45:55 +0100 |
|---|---|---|
| committer | Sebastian Thiel <sebastian.thiel@icloud.com> | 2020-07-13 22:55:29 +0800 |
| commit | 30387f16920f69544fcc7db40dfae554bcd7d1cc (patch) | |
| tree | 93012b9f2780edf7201d5ff20deec2e083837cbd /git/index/base.py | |
| parent | 9b68361c8b81b23be477b485e2738844e0832b2f (diff) | |
| download | gitpython-30387f16920f69544fcc7db40dfae554bcd7d1cc.tar.gz | |
Fixed all warnings in documentation and updated Makefile to treat warnings as errors.
Diffstat (limited to 'git/index/base.py')
| -rw-r--r-- | git/index/base.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/git/index/base.py b/git/index/base.py index 02299275..62ac9389 100644 --- a/git/index/base.py +++ b/git/index/base.py @@ -219,7 +219,7 @@ class IndexFile(LazyMixin, diff.Diffable, Serializable): """Merge the given rhs treeish into the current index, possibly taking a common base treeish into account. - As opposed to the from_tree_ method, this allows you to use an already + As opposed to the :func:`IndexFile.from_tree` method, this allows you to use an already existing tree as the left side of the merge :param rhs: @@ -830,7 +830,7 @@ class IndexFile(LazyMixin, diff.Diffable, Serializable): to a path relative to the git repository directory containing the working tree - The path string may include globs, such as *.c. + The path string may include globs, such as \\*.c. - Blob Object Only the path portion is used in this case. @@ -998,7 +998,7 @@ class IndexFile(LazyMixin, diff.Diffable, Serializable): If False, these will trigger a CheckoutError. :param fprogress: - see Index.add_ for signature and explanation. + see :func:`IndexFile.add` for signature and explanation. The provided progress information will contain None as path and item if no explicit paths are given. Otherwise progress information will be send prior and after a file has been checked out @@ -1010,7 +1010,7 @@ class IndexFile(LazyMixin, diff.Diffable, Serializable): iterable yielding paths to files which have been checked out and are guaranteed to match the version stored in the index - :raise CheckoutError: + :raise exc.CheckoutError: If at least one file failed to be checked out. This is a summary, hence it will checkout as many files as it can anyway. If one of files or directories do not exist in the index |