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/index/fun.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/index/fun.py')
-rw-r--r-- | lib/git/index/fun.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/git/index/fun.py b/lib/git/index/fun.py index ef950761..cc18c65c 100644 --- a/lib/git/index/fun.py +++ b/lib/git/index/fun.py @@ -51,8 +51,10 @@ def write_cache(entries, stream, extension_data=None, ShaStreamCls=IndexFileSHA1 :param entries: **sorted** list of entries :param stream: stream to wrap into the AdapterStreamCls - it is used for final output. + :param ShaStreamCls: Type to use when writing to the stream. It produces a sha while writing to it, before the data is passed on to the wrapped stream + :param extension_data: any kind of data to write as a trailer, it must begin a 4 byte identifier, followed by its size ( 4 bytes )""" # wrap the stream into a compatible writer @@ -103,7 +105,7 @@ def read_header(stream): def entry_key(*entry): """:return: Key suitable to be used for the index.entries dictionary - :param *entry: One instance of type BaseIndexEntry or the path and the stage""" + :param entry: One instance of type BaseIndexEntry or the path and the stage""" if len(entry) == 1: return (entry[0].path, entry[0].stage) else: |