Skip to content

Commit 95812c8

Browse files
committed
Value: bindValueF: add doc
1 parent bfc1c41 commit 95812c8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/Nix/Value.hs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -207,10 +207,10 @@ sequenceNValueF transform = \case
207207
-- | @bind@
208208
bindNValueF
209209
:: (Monad m, Monad n)
210-
=> (forall x . n x -> m x)
211-
-> (a -> n b)
212-
-> NValueF p m a
213-
-> n (NValueF p m b)
210+
=> (forall x . n x -> m x) -- ^ Transform @n@ into @m@.
211+
-> (a -> n b) -- ^ A Kleisli arrow (see 'Control.Arrow.Kleisli' & Kleisli catagory).
212+
-> NValueF p m a -- ^ "Unfixed" (openly recursive) value of an embedded Nix language.
213+
-> n (NValueF p m b) -- ^ An implementation of @transform (f =<< x)@ for embedded Nix language values.
214214
bindNValueF transform f = \case
215215
NVConstantF a -> pure $ NVConstantF a
216216
NVStrF s -> pure $ NVStrF s

0 commit comments

Comments
 (0)