summaryrefslogtreecommitdiff
path: root/lib/git/refs.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/git/refs.py')
-rw-r--r--lib/git/refs.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/git/refs.py b/lib/git/refs.py
index af7284ff..3dc73d03 100644
--- a/lib/git/refs.py
+++ b/lib/git/refs.py
@@ -489,6 +489,8 @@ class SymbolicReference(object):
@classmethod
def from_path(cls, repo, path):
"""
+ :param path: full .git-directory-relative path name to the Reference to instantiate
+ :note: use to_full_path() if you only have a partial path of a known Reference Type
:return:
Instance of type Reference, Head, or Tag
depending on the given path"""