improve comment

This commit is contained in:
Joey Hess 2016-09-21 14:57:44 -04:00
parent 8dae86eac2
commit 99982e2830
No known key found for this signature in database
GPG key ID: C910D9222512E3C7

View 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