summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Gerard <info@content-baer.de>2022-08-20 12:37:48 +0100
committerPatrick Gerard <info@content-baer.de>2022-08-20 12:49:16 +0100
commit7dda25eafa80fc6cb2dd0a21f992205119270007 (patch)
treeb73f1a35038897adb82f7861540e6e52f9eb6391
parent6aa7fc525c81681bd7fd42dd1c025cbad92e34d7 (diff)
downloadgitpython-7dda25eafa80fc6cb2dd0a21f992205119270007.tar.gz
docs: add typerror exception to active_branch method
docs: add typerror exception to active_branch method fix: sphinx syntax add author
-rw-r--r--AUTHORS1
-rw-r--r--git/repo/base.py2
2 files changed, 3 insertions, 0 deletions
diff --git a/AUTHORS b/AUTHORS
index 2ac02e5f..ef414e31 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -47,4 +47,5 @@ Contributors are:
-Hugo van Kemenade
-Hiroki Tokunaga <tokusan441 _at_ gmail.com>
-Julien Mauroy <pro.julien.mauroy _at_ gmail.com>
+-Patrick Gerard
Portions derived from other open source works and are clearly marked.
diff --git a/git/repo/base.py b/git/repo/base.py
index 5a85cc4e..a1be5ff9 100644
--- a/git/repo/base.py
+++ b/git/repo/base.py
@@ -858,6 +858,8 @@ class Repo(object):
@property
def active_branch(self) -> Head:
"""The name of the currently active branch.
+
+ :raises TypeError: If HEAD is detached
:return: Head to the active branch"""
# reveal_type(self.head.reference) # => Reference
return self.head.reference