From 99982e28300d30f1cc4fa54f61082f52c1ad6385 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Wed, 21 Sep 2016 14:57:44 -0400 Subject: [PATCH] improve comment --- Git/Ref.hs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Git/Ref.hs b/Git/Ref.hs index 6cd56271ff..257c430360 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 -- 2.30.2