summaryrefslogtreecommitdiff
path: root/git/refs
diff options
context:
space:
mode:
Diffstat (limited to 'git/refs')
-rw-r--r--git/refs/symbolic.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/git/refs/symbolic.py b/git/refs/symbolic.py
index 9937cf0c..aec68750 100644
--- a/git/refs/symbolic.py
+++ b/git/refs/symbolic.py
@@ -478,7 +478,8 @@ class SymbolicReference(object):
created at, i.e. "NEW_HEAD" or "symrefs/my_new_symref"
:param reference:
- The reference to which the new symbolic reference should point to
+ The reference to which the new symbolic reference should point to.
+ If it is a commit'ish, the symbolic ref will be detached.
:param force:
if True, force creation even if a symbolic reference with that name already exists.