openstack/deb-python-pygit2
Code Issues Proposed changes

Add example for repo.walk pydoc

Browse Source
This commit is contained in:
Andrey Devyatkin 2013-05-17 22:20:44 +02:00
parent 4f83209a9a
commit 785b5112ab
1 changed files with 8 additions and 1 deletions

9
src/repository.c

@ -540,7 +540,14 @@ Repository_merge_base(Repository *self, PyObject *args)
PyDoc_STRVAR(Repository_walk__doc__,
"walk(oid, sort_mode) -> iterator\n"
"\n"
"Generator that traverses the history starting from the given commit.");
"Generator that traverses the history starting from the given commit.\n"
"\n"
"Example:\n"
"\n"
"import pygit2"
"repo = pygit2.Repository(.git)\n"
"for object in repo.walk(repo.head.oid, pygit2.GIT_SORT_TOPOLOGICAL):\n"
" print object.message");
PyObject *
Repository_walk(Repository *self, PyObject *args)