diff options
| author |  Joey Hess <joeyh@joeyh.name> | 2016-09-21 14:57:44 -0400 |
|---|---|---|
| committer | Joey Hess <joeyh@joeyh.name> | 2016-09-21 14:57:44 -0400 |
| commit | 7bed6cb201b5ac528383b830ef5ab8807cb86adb (patch) | |
| tree | c9f3279a34f140039c36ea5a8049a7c33a469245 | |
| parent | c36a1e34efd0e3144acee6fee96e3ea63aa65295 (diff) | |
improve comment
| -rw-r--r-- | Git/Ref.hs | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Git/Ref.hs b/Git/Ref.hs index 6cd56271f..257c43036 100644 --- a/Git/Ref.hs +++ b/Git/Ref.hs @@ -28,8 +28,10 @@ setHeadRef ref r = writeFile (headFile r) ("ref: " ++ fromRef ref) describe :: Ref -> String describe = fromRef . base -{- Often git refs are fully qualified (eg: refs/heads/master). - - Converts such a fully qualified ref into a base ref (eg: master). -} +{- Often git refs are fully qualified + - (eg refs/heads/master or refs/remotes/origin/master). + - Converts such a fully qualified ref into a base ref + - (eg: master or origin/master). -} base :: Ref -> Ref base = Ref . remove "refs/heads/" . remove "refs/remotes/" . fromRef where |