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:37:48 +0100
commit1cf7e92aa310456945ae7da16f253b1331027a5b (patch)
tree699f1b453117855b0a13cd9c984018dd042dffd1
parent6aa7fc525c81681bd7fd42dd1c025cbad92e34d7 (diff)
downloadgitpython-1cf7e92aa310456945ae7da16f253b1331027a5b.tar.gz
docs: add typerror exception to active_branch method
-rw-r--r--git/repo/base.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/git/repo/base.py b/git/repo/base.py
index 5a85cc4e..0fed0e4e 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