diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2010-07-14 20:14:29 +0200 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2010-07-14 20:14:29 +0200 |
| commit | 17a172920fde8c6688c8a1a39f258629b8b73757 (patch) | |
| tree | 97735a11812af8acc54415101649b9a8ee18cd12 | |
| parent | 24740f22c59c3bcafa7b2c1f2ec997e4e14f3615 (diff) | |
| download | gitpython-17a172920fde8c6688c8a1a39f258629b8b73757.tar.gz | |
Fixed the missing Repo type documentation thanks to a hint of gasche, fixed a few more resT syntax errors on the way
| -rw-r--r-- | doc/source/reference.rst | 13 | ||||
| -rw-r--r-- | lib/git/index/base.py | 4 | ||||
| -rw-r--r-- | lib/git/index/fun.py | 2 |
3 files changed, 14 insertions, 5 deletions
diff --git a/doc/source/reference.rst b/doc/source/reference.rst index 5952fe2d..b6697d71 100644 --- a/doc/source/reference.rst +++ b/doc/source/reference.rst @@ -131,10 +131,17 @@ Remote :members: :undoc-members: -Repo ----- +Repo.Base +--------- + +.. automodule:: git.repo.base + :members: + :undoc-members: + +Repo.Functions +-------------- -.. automodule:: git.repo +.. automodule:: git.repo.fun :members: :undoc-members: diff --git a/lib/git/index/base.py b/lib/git/index/base.py index 5011a932..386926c5 100644 --- a/lib/git/index/base.py +++ b/lib/git/index/base.py @@ -445,12 +445,12 @@ class IndexFile(LazyMixin, diff.Diffable, Serializable): def unmerged_blobs(self): """ - Returns + :return: Iterator yielding dict(path : list( tuple( stage, Blob, ...))), being a dictionary associating a path in the index with a list containing sorted stage/blob pairs - Note: + :note: Blobs that have been removed in one side simply do not exist in the given stage. I.e. a file removed on the 'other' branch whose entries are at stage 3 will not have a stage 3 entry. diff --git a/lib/git/index/fun.py b/lib/git/index/fun.py index fac559c5..4478228a 100644 --- a/lib/git/index/fun.py +++ b/lib/git/index/fun.py @@ -48,6 +48,7 @@ def write_cache_entry(entry, stream): def write_cache(entries, stream, extension_data=None, ShaStreamCls=IndexFileSHA1Writer): """Write the cache represented by entries to a stream + :param entries: **sorted** list of entries :param stream: stream to wrap into the AdapterStreamCls - it is used for final output. @@ -149,6 +150,7 @@ def read_cache(stream): def write_tree_from_cache(entries, odb, sl, si=0): """Create a tree from the given sorted list of entries and put the respective trees into the given object database + :param entries: **sorted** list of IndexEntries :param odb: object database to store the trees in :param si: start index at which we should start creating subtrees |