From 2bd73f3bdfae9d4274ea394cc91095270c9556cf Mon Sep 17 00:00:00 2001
From: djmattyg007 <git@matthewgamble.net>
Date: Sat, 23 Aug 2014 01:06:30 +1000
Subject: [PATCH 1/5] Clear up confusion regarding accepted types for
Repository.checkout() refname parameter
---
pygit2/repository.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pygit2/repository.py b/pygit2/repository.py
index 45bc170..c450d37 100644
--- a/pygit2/repository.py
+++ b/pygit2/repository.py
@@ -244,7 +244,7 @@ class Repository(_Repository):
Arguments:
- :param str refname: The reference to checkout. After checkout,
+ :param str|Reference refname: The reference to checkout. After checkout,
the current branch will be switched to this one.
:param int strategy: A ``GIT_CHECKOUT_`` value. The default is
From 9718fd8c32938a38d7973e39a32df2526e2bfa8e Mon Sep 17 00:00:00 2001
From: djmattyg007 <git@matthewgamble.net>
Date: Sat, 23 Aug 2014 01:08:32 +1000
Subject: [PATCH 2/5] Add note about checkout('HEAD') being identical to
checkout_head()
---
pygit2/repository.py | 2 ++
1 file changed, 2 insertions(+)
diff --git a/pygit2/repository.py b/pygit2/repository.py
index c450d37..e704a5d 100644
--- a/pygit2/repository.py
+++ b/pygit2/repository.py
@@ -240,6 +240,8 @@ class Repository(_Repository):
>>> checkout('HEAD')
+ This is identical to calling checkout_head().
+
If no reference is given, checkout from the index.
Arguments:
From e4315aa0a5224c240a2626fe7bf0ace0cb708e31 Mon Sep 17 00:00:00 2001
From: djmattyg007 <git@matthewgamble.net>
Date: Sat, 23 Aug 2014 10:56:48 +1000
Subject: [PATCH 3/5] Add note about default behaviour of
Repository.listall_branches()
---
src/repository.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/repository.c b/src/repository.c
index a4a4b1d..6f40dfd 100644
--- a/src/repository.c
+++ b/src/repository.c
@@ -968,7 +968,8 @@ out:
PyDoc_STRVAR(Repository_listall_branches__doc__,
"listall_branches([flags]) -> [str, ...]\n"
"\n"
- "Return a tuple with all the branches in the repository.");
+ "Return a tuple with all the branches in the repository.\n"
+ "By default, it returns all local branches.");
PyObject *
Repository_listall_branches(Repository *self, PyObject *args)
From 4a53b2c8aeb6fe2e36e7bab2c5154bb8cdade895 Mon Sep 17 00:00:00 2001
From: djmattyg007 <git@matthewgamble.net>
Date: Sat, 23 Aug 2014 11:15:49 +1000
Subject: [PATCH 4/5] Add note about including remote name when looking up
remote branch
---
src/repository.c | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/src/repository.c b/src/repository.c
index 6f40dfd..8a1400e 100644
--- a/src/repository.c
+++ b/src/repository.c
@@ -295,7 +295,9 @@ Repository_git_object_lookup_prefix(Repository *self, PyObject *key)
PyDoc_STRVAR(Repository_lookup_branch__doc__,
"lookup_branch(branch_name, [branch_type]) -> Object\n"
"\n"
- "Returns the Git reference for the given branch name (local or remote).");
+ "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"
+ "in the branch name (eg 'origin/master').");
PyObject *
Repository_lookup_branch(Repository *self, PyObject *args)
From 21efebd305c2b8ee33f0fa81cd557fea8ffb933a Mon Sep 17 00:00:00 2001
From: djmattyg007 <git@matthewgamble.net>
Date: Sat, 23 Aug 2014 11:29:27 +1000
Subject: [PATCH 5/5] Clarify return types from
Repository.{create,lookup}_branch()
---
src/repository.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/repository.c b/src/repository.c
index 8a1400e..2b99558 100644
--- a/src/repository.c
+++ b/src/repository.c
@@ -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"
@@ -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"