f79d1b2 · patch · git.iko.soy

git.iko.soy/patch

on develop help sign in

Merge pull request #19 from reflex-frp/eac@update-description

f79d1b2John Ericson6 years ago

README.md+6−4

compare with develop

unifiedsplit

@@ -1,8 +1,10 @@

1−## Patch

1+# patch

3−Infrastructure for writing patches which act on other types.

3+[![Haskell](https://img.shields.io/badge/language-Haskell-orange.svg)](https://haskell.org) [![Hackage](https://img.shields.io/hackage/v/patch.svg)](https://hackage.haskell.org/package/patch) [![Hackage CI](https://matrix.hackage.haskell.org/api/v2/packages/patch/badge)](https://matrix.hackage.haskell.org/#/package/patch) [![Travis CI](https://api.travis-ci.org/reflex-frp/patch.svg?branch=develop)](https://travis-ci.org/reflex-frp/patch) [![BSD3 License](https://img.shields.io/badge/license-BSD3-blue.svg)](https://github.com/reflex-frp/patch/LICENSE)

5+Data structures for describing changes to other data structures.

5−A `Patch` type represents a kind of change made to a datastructure.

7+A `Patch` type represents a kind of change made to a data structure.

7```haskell

9```haskell

8class Patch p where

10class Patch p where

@@ -12,7 +14,7 @@ class Patch p where

12 apply :: p -> PatchTarget p -> Maybe (PatchTarget p)

14 apply :: p -> PatchTarget p -> Maybe (PatchTarget p)

13```

15```

15−### Patching Maps

17+## Patching Maps

16For example, `Data.Patch.Map` defines the `PatchMap` type which can be used to patch `Map`s. A `PatchMap` represents updates to a `Map` that can insert, remove, or replace items in the `Map`. In this example, the `Map` is the `PatchTarget` and the `PatchMap` is the `Patch`. Keep in mind that there are many other possible `Patch`es that can be applied to a `Map` (i.e., `Map` can be the `PatchTarget` for many different `Patch` instances).

18For example, `Data.Patch.Map` defines the `PatchMap` type which can be used to patch `Map`s. A `PatchMap` represents updates to a `Map` that can insert, remove, or replace items in the `Map`. In this example, the `Map` is the `PatchTarget` and the `PatchMap` is the `Patch`. Keep in mind that there are many other possible `Patch`es that can be applied to a `Map` (i.e., `Map` can be the `PatchTarget` for many different `Patch` instances).

18`PatchMap` is defined as:

20`PatchMap` is defined as:

patch.cabal+4−2

@@ -1,7 +1,9 @@

1Name: patch

2Version: 0.0.3.1

3−Synopsis: Infrastructure for writing patches which act on other types.

3+Synopsis: Data structures for describing changes to other data structures.

4Description:

5+ Data structures for describing changes to other data structures.

6+ .

5 In this library, a patch is something which can be applied, analogous to a

7 In this library, a patch is something which can be applied, analogous to a

6 function, and which distinguishes returning the argument it was provided from

8 function, and which distinguishes returning the argument it was provided from

7 returning something else.

9 returning something else.

@@ -20,7 +22,7 @@ extra-source-files:

20 ChangeLog.md

22 ChangeLog.md

22tested-with:

24tested-with:

23− GHC ==8.0.2 || ==8.2.2 || ==8.4.4 || ==8.6.5 || ==8.8.1

25+ GHC ==8.0.2 || ==8.2.2 || ==8.4.4 || ==8.6.5 || ==8.8.1

24 GHCJS ==8.4

26 GHCJS ==8.4

26flag split-these

28flag split-these