summaryrefslogtreecommitdiff
path: root/git/repo/base.py
diff options
context:
space:
mode:
authorSebastian Thiel <sebastian.thiel@icloud.com>2022-08-21 09:33:50 +0800
committerGitHub <noreply@github.com>2022-08-21 09:33:50 +0800
commit12d91c6459422c034b790c8bcc5e429aa3a42c3b (patch)
treeb73f1a35038897adb82f7861540e6e52f9eb6391 /git/repo/base.py
parent6aa7fc525c81681bd7fd42dd1c025cbad92e34d7 (diff)
parent9af77b53617826586ed2702536a3534cf570c958 (diff)
downloadgitpython-12d91c6459422c034b790c8bcc5e429aa3a42c3b.tar.gz
Merge pull request #1481 from grumpyp/main
Improve docs
Diffstat (limited to 'git/repo/base.py')
-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..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