Skip to content

Commit f79d1b2

Browse files
authored
Merge pull request #19 from reflex-frp/eac@update-description
Update project description
2 parents 89bd319 + 1e71a97 commit f79d1b2

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
## Patch
1+
# patch
22

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)
44

5-
A `Patch` type represents a kind of change made to a datastructure.
5+
Data structures for describing changes to other data structures.
6+
7+
A `Patch` type represents a kind of change made to a data structure.
68

79
```haskell
810
class Patch p where
@@ -12,7 +14,7 @@ class Patch p where
1214
apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
1315
```
1416

15-
### Patching Maps
17+
## Patching Maps
1618
For 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).
1719

1820
`PatchMap` is defined as:

patch.cabal

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
Name: patch
22
Version: 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.
44
Description:
5+
Data structures for describing changes to other data structures.
6+
.
57
In this library, a patch is something which can be applied, analogous to a
68
function, and which distinguishes returning the argument it was provided from
79
returning something else.
@@ -20,7 +22,7 @@ extra-source-files:
2022
ChangeLog.md
2123

2224
tested-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
2426
GHCJS ==8.4
2527

2628
flag split-these

0 commit comments

Comments
 (0)