improve comment
authorJoey Hess <joeyh@joeyh.name>
Wed, 21 Sep 2016 18:57:44 +0000 (14:57 -0400)
committerJoey Hess <joeyh@joeyh.name>
Wed, 21 Sep 2016 18:57:44 +0000 (14:57 -0400)
Git/Ref.hs

index 6cd56271ffeed832b3ba129f22a8f699d4e755fa..257c430360679ec080d3b31aa2b5a1c5dba49897 100644 (file)
@@ -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