Skip to content

Commit

Permalink
Place Veither doc on top of kind declaration
Browse files Browse the repository at this point in the history
This was originally placed here but had to be moved
to the newtype declaration because purs didn't
produce docs for kind signatures before v0.14.3
  • Loading branch information
JordanMartinez committed Sep 11, 2021
1 parent 9fb195b commit 95d8523
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/Data/Veither.purs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ import Test.QuickCheck.Gen (Gen, oneOf, frequency)
import Type.Proxy (Proxy(..))
import Unsafe.Coerce (unsafeCoerce)

newtype VeitherRow Type Type Type
-- | `Veither` is the same as `Either` except that the `l` type can be zero to many different types.
-- | `Veither` has all the instances that `Either` has, except for `Eq1` and `Ord1`, which simply
-- | haven't been implemented yet. If you would use a function from `Data.Either` (e.g. hush) and
Expand Down Expand Up @@ -100,6 +99,7 @@ newtype Veither ∷ Row Type → Type → Type
-- | - `genVeitherUniform` - same as `genEither` but with uniform probability
-- | - `genVeitherFrequency` - same as `genEither` but with user-specified probability
-- |
newtype VeitherRow Type Type Type
newtype Veither errorRows a = Veither (Variant ("_" ∷ a | errorRows))

-- | Proxy type for `Veither`'s happy path (e.g. `Either`'s `Right` constructor).
Expand Down

0 comments on commit 95d8523

Please sign in to comment.