1
1
mirror of https://github.com/github/semantic.git synced 2024-12-03 00:16:52 +03:00

Haddock-friendly 📝 of AlgorithmF.

This commit is contained in:
Rob Rix 2016-08-04 12:31:18 -04:00
parent d2cbccede2
commit e0da05538e

View File

@ -4,10 +4,11 @@ import Control.Monad.Free.Church
import Prologue
-- | A single step in a diffing algorithm.
data AlgorithmF
term -- ^ The type of terms.
diff -- ^ The type of diffs.
f -- ^ The type representing another level of the diffing algorithm. Often Algorithm.
--
-- 'term' is the type of terms.
-- 'diff' is the type of diffs.
-- 'f' represents the continuation after diffing. Often 'Algorithm'.
data AlgorithmF term diff f
-- | Recursively diff two terms and pass the result to the continuation.
= Recursive term term (diff -> f)
-- | Diff two lists by each elements position, and pass the resulting list of diffs to the continuation.