Skip to content

Commit

Permalink
Added incompatibility for <+>
Browse files Browse the repository at this point in the history
  • Loading branch information
j-mie6 committed Dec 21, 2022
1 parent 72d4516 commit 50c706c
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ Documentation can be found [**here**][Link-Scaladoc]
[Parsley](https://github.com/j-mie6/parsley) is a fast, modern, parser combinator library based loosely on Haskell's `parsec` and
`megaparsec`. For examples, see its repo and wiki!

## Known Incompatiblities
The following are known conflicts between the syntactic extensions of `cats` and the base combinators on `parsley`. This only needs to be considered when writing _concrete_ values of type `Parsley[A]`: combinators that rely on generic instances over a type `F` will use the `cats` version of the conflicting combinators.

* The `SemigroupK` syntax for `combine` of `<+>` is incompatible with `parsley`, which defines
`<+>` to be a combine combinator returning `Parsley[Either[A, B]]`: the `cats` combinator `<+>` is known in `parsley` as `<|>`, `orElse`, or `|`.


<!-- examples should go here, but <+> conflicts between parsley and cats,
which makes examples difficult... -->

Expand Down

0 comments on commit 50c706c

Please sign in to comment.