From 87b3494f773e53a689cdf88ba9985d35e4b925d9 Mon Sep 17 00:00:00 2001
From: Kevin Quick <kquick@galois.com>
Date: Mon, 28 Jan 2019 15:02:43 -0800
Subject: [PATCH] [refinement] add documentation for takePath function.

---
 refinement/src/Data/Macaw/Refinement/Path.hs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/refinement/src/Data/Macaw/Refinement/Path.hs b/refinement/src/Data/Macaw/Refinement/Path.hs
index d2dfd0b6..22023843 100644
--- a/refinement/src/Data/Macaw/Refinement/Path.hs
+++ b/refinement/src/Data/Macaw/Refinement/Path.hs
@@ -55,6 +55,8 @@ pathTo blkID (p@(Path i anc _):ps) =
 pathTo _ [] = Nothing
 
 
+-- | Returns the first n levels (callers) for the specified Block path
+-- in the Function.
 takePath :: Int -> FuncBlockPath arch -> FuncBlockPath arch
 takePath n (Path blkid anc loop) =
   if n > 0