openstack/deb-python-pygit2
Code Issues Proposed changes

Fix documentation for Repository.listall_branches

Browse Source 
Add a description of the possible flags and turn the "tuple" into a
"list", as it had already happened in code and part of the documentation
in aa5877e0.
This commit is contained in:
Richard Möhn
2015-01-09 19:25:50 +01:00
parent 22d1aef50d
commit d341cff7d6
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/repository.c
View File

@@ -936,10 +936,15 @@ out:
PyDoc_STRVAR(Repository_listall_branches__doc__, PyDoc_STRVAR(Repository_listall_branches__doc__,
"listall_branches([flags]) -> [str, ...]\n" "listall_branches([flag]) -> [str, ...]\n"
"\n" "\n"
"Return a tuple with all the branches in the repository.\n" "Return a list with all the branches in the repository.\n"
"By default, it returns all local branches."); "\n"
"The *flag* may be:\n"
"\n"
"- GIT_BRANCH_LOCAL - return all local branches (set by default)\n"
"- GIT_BRANCH_REMOTE - return all remote-tracking branches\n"
"- GIT_BRANCH_ALL - return local branches and remote-tracking branches");
PyObject * PyObject *
Repository_listall_branches(Repository *self, PyObject *args) Repository_listall_branches(Repository *self, PyObject *args)