Skip to content

Commit

Permalink
Changelog entry for version 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ddssff committed Nov 3, 2024
1 parent eb7c660 commit ff71c2b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# 1.0

- Add Unix diff style annotations to output of `prettyContextDiff`,
e.g `@@ -1,5 +1,4 @@`. This required three changes to the
signature of `getContextDiff` due to the addition of a wrapper type
`Numbered`, which enumerates the elements of the input list.

- Signature change 1: The element pretty printer type changes from
`(a -> Doc)` to `(Numbered a -> Doc)`. An unnumber function is
provided so that the old behavior can be obtained by changing that
argument from `pretty` to `(pretty . unnumber)`

- Signature change 2: The result type of getContextDiff changes from
`ContextDiff a` to `ContextDiff (Numbered a)`. A function
`unNumberContextDiff` is provided to convert the result back to
the old type.

- Signature change 3: the context argument is now `Maybe Int` rather
than `Int`, reflecting the change made to `getContextDiffNew` in 0.5.

- A `prettyContextDiffOld` function is provided to get the old
style output.

- The old broken version of getContextDiffOld is removed.

- Document the behavior of `groupBy'`.

# 0.5

- Bring space complexity down to D^2 (Bodigrim).
Expand Down
2 changes: 1 addition & 1 deletion Diff.cabal
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Cabal-Version: >= 1.18
Cabal-Version: 1.18
name: Diff
version: 1.0
synopsis: Diff algorithm in pure Haskell
Expand Down

0 comments on commit ff71c2b

Please sign in to comment.