Skip to content

Commit b1153c6

Browse files
committed
Slightly improve haddock
1 parent d7688a9 commit b1153c6

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/Data/Patch/PatchOrReplacement.hs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ import GHC.Generics
2222
-- inefficiently. 'PatchOrReplacement' can be used as an escape hatch:
2323
-- when the change as a patch would be too big, just provide a new value
2424
-- to replace the old one with instead.
25+
--
26+
-- @since 0.0.6
2527
data PatchOrReplacement p
2628
= PatchOrReplacement_Patch p
2729
| PatchOrReplacement_Replacement (PatchTarget p)
@@ -37,8 +39,8 @@ completePatchOrReplacement = \case
3739
PatchOrReplacement_Replacement t -> Just t
3840
PatchOrReplacement_Patch _ -> Nothing
3941

40-
-- | 'PatchOrReplacement p' is a patch when we can apply the patch or
41-
-- replace the old value with the new replacement value.
42+
-- | To apply a 'PatchOrReplacement p' apply the the underlying 'p' or
43+
-- substitute the replacement 'PatchTarget p'.
4244
instance Patch p => Patch (PatchOrReplacement p) where
4345
type PatchTarget (PatchOrReplacement p) = PatchTarget p
4446
apply = \case

0 commit comments

Comments
 (0)