Skip to content

Commit 17a1729

Browse files
committed
Fixed the missing Repo type documentation thanks to a hint of gasche, fixed a few more resT syntax errors on the way
1 parent 24740f2 commit 17a1729

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

‎doc/source/reference.rst

+10-3
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,17 @@ Remote
131131
:members:
132132
:undoc-members:
133133

134-
Repo
135-
----
134+
Repo.Base
135+
---------
136+
137+
.. automodule:: git.repo.base
138+
:members:
139+
:undoc-members:
140+
141+
Repo.Functions
142+
--------------
136143

137-
.. automodule:: git.repo
144+
.. automodule:: git.repo.fun
138145
:members:
139146
:undoc-members:
140147

‎lib/git/index/base.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -445,12 +445,12 @@ def iter_blobs(self, predicate = lambda t: True):
445445

446446
def unmerged_blobs(self):
447447
"""
448-
Returns
448+
:return:
449449
Iterator yielding dict(path : list( tuple( stage, Blob, ...))), being
450450
a dictionary associating a path in the index with a list containing
451451
sorted stage/blob pairs
452452
453-
Note:
453+
:note:
454454
Blobs that have been removed in one side simply do not exist in the
455455
given stage. I.e. a file removed on the 'other' branch whose entries
456456
are at stage 3 will not have a stage 3 entry.

‎lib/git/index/fun.py

+2
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ def write_cache_entry(entry, stream):
4848

4949
def write_cache(entries, stream, extension_data=None, ShaStreamCls=IndexFileSHA1Writer):
5050
"""Write the cache represented by entries to a stream
51+
5152
:param entries: **sorted** list of entries
5253
:param stream: stream to wrap into the AdapterStreamCls - it is used for
5354
final output.
@@ -149,6 +150,7 @@ def read_cache(stream):
149150
def write_tree_from_cache(entries, odb, sl, si=0):
150151
"""Create a tree from the given sorted list of entries and put the respective
151152
trees into the given object database
153+
152154
:param entries: **sorted** list of IndexEntries
153155
:param odb: object database to store the trees in
154156
:param si: start index at which we should start creating subtrees

0 commit comments

Comments
 (0)