summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHoussam Kherraz <houssam.kherraz@kensho.com>2022-02-23 10:20:19 -0500
committerSebastian Thiel <sebastian.thiel@icloud.com>2022-02-24 07:45:16 +0800
commit56f18ac6d9efc12d0aa9406a0b28c82fcf73aca5 (patch)
tree1abdea7f22cfbdf8914191bba5c5e5d181c4b98b
parentc0f2cf373e8296d07b3a7d7610add0cf3d5957be (diff)
downloadgitpython-56f18ac6d9efc12d0aa9406a0b28c82fcf73aca5.tar.gz
fix iter_commits comment, more in line with iter_items
-rw-r--r--git/repo/base.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/git/repo/base.py b/git/repo/base.py
index 7713c915..510eb12b 100644
--- a/git/repo/base.py
+++ b/git/repo/base.py
@@ -567,8 +567,8 @@ class Repo(object):
If None, the active branch will be used.
:param paths:
- is an optional path or a list of paths to limit the returned commits to
- Commits that do not contain that path or the paths will not be returned.
+ is an optional path or a list of paths; if set only commits that include the path
+ or paths will be returned
:param kwargs:
Arguments to be passed to git-rev-list - common ones are