Skip to content

Ongoing attempt to improve documentation. #409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdavid merged 5 commits into from
Aug 26, 2014
Merged

Ongoing attempt to improve documentation. #409

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2bd73f3
Clear up confusion regarding accepted types for Repository.checkout()…
djmattyg007 Aug 22, 2014
9718fd8
Add note about checkout('HEAD') being identical to checkout_head()
djmattyg007 Aug 22, 2014
e4315aa
Add note about default behaviour of Repository.listall_branches()
djmattyg007 Aug 23, 2014
4a53b2c
Add note about including remote name when looking up remote branch
djmattyg007 Aug 23, 2014
21efebd
Clarify return types from Repository.{create,lookup}_branch()
djmattyg007 Aug 23, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Clarify return types from Repository.{create,lookup}_branch()
  • Loading branch information
@djmattyg007
djmattyg007 committed Aug 23, 2014
commit 21efebd305c2b8ee33f0fa81cd557fea8ffb933a
4 changes: 2 additions & 2 deletions src/repository.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ Repository_git_object_lookup_prefix(Repository *self, PyObject *key)


PyDoc_STRVAR(Repository_lookup_branch__doc__,
"lookup_branch(branch_name, [branch_type]) -> Object\n"
"lookup_branch(branch_name, [branch_type]) -> Branch\n"
"\n"
"Returns the Git reference for the given branch name (local or remote).\n"
"If branch_type is GIT_BRANCH_REMOTE, you must include the remote name\n"
Expand Down Expand Up @@ -895,7 +895,7 @@ Repository_create_tag(Repository *self, PyObject *args)


PyDoc_STRVAR(Repository_create_branch__doc__,
"create_branch(name, commit, force=False) -> bytes\n"
"create_branch(name, commit, force=False) -> Branch\n"
"\n"
"Create a new branch \"name\" which points to a commit.\n"
"\n"
Expand Down