1
1
mirror of https://github.com/github/semantic.git synced 2024-12-01 09:15:01 +03:00

Correct the docs for the smart constructors.

This commit is contained in:
Rob Rix 2017-02-21 11:39:41 -05:00
parent 330873659c
commit 691f7cfebf

View File

@ -25,14 +25,14 @@ iterAp algebra = go
-- DSL
-- | Constructs a 'Recursive' diff of two terms.
-- | Diff two terms linearly.
linearly :: term -> term -> Algorithm term diff diff
linearly a b = liftAp (Linear a b)
-- | Constructs a 'ByIndex' diff of two lists of terms.
-- | Diff two terms using SES.
bySES :: [term] -> [term] -> Algorithm term diff [diff]
bySES a b = liftAp (SES a b)
-- | Constructs a 'BySimilarity' diff of two lists of terms.
-- | Diff two terms using RWS.
byRWS :: [term] -> [term] -> Algorithm term diff [diff]
byRWS a b = liftAp (RWS a b)