diff options
author | Sebastian Thiel <byronimo@gmail.com> | 2010-06-29 18:28:31 +0200 |
---|---|---|
committer | Sebastian Thiel <byronimo@gmail.com> | 2010-06-29 18:28:31 +0200 |
commit | 160081b9a7ca191afbec077c4bf970cfd9070d2c (patch) | |
tree | 5e47a446919fbdd5f7a9a82b6944dc2f1b32bdba /lib/git/utils.py | |
parent | 6917ae4ce9eaa0f5ea91592988c1ea830626ac3a (diff) | |
download | gitpython-160081b9a7ca191afbec077c4bf970cfd9070d2c.tar.gz |
Updated and fixed sphinx API docs, which included one quick skim-through
Diffstat (limited to 'lib/git/utils.py')
-rw-r--r-- | lib/git/utils.py | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/git/utils.py b/lib/git/utils.py index e49fcc2a..54c3414e 100644 --- a/lib/git/utils.py +++ b/lib/git/utils.py @@ -269,7 +269,8 @@ class BlockingLockFile(LockFile): class IterableList(list): - """List of iterable objects allowing to query an object by id or by named index:: + """ + List of iterable objects allowing to query an object by id or by named index:: heads = repo.heads heads.master @@ -317,11 +318,13 @@ class Iterable(object): @classmethod def list_items(cls, repo, *args, **kwargs): - """Find all items of this type - subclasses can specify args and kwargs differently. + """ + Find all items of this type - subclasses can specify args and kwargs differently. If no args are given, subclasses are obliged to return all items if no additional arguments arg given. - :note: Favor the iter_items method as it will + :note: Favor the iter_items method as it will + :return:list(Item,...) list of item instances""" out_list = IterableList( cls._id_attribute_ ) out_list.extend(cls.iter_items(repo, *args, **kwargs)) |