~ruther/guix-local

60a9fcb1377e4acc78a930904ef80b69a1c63f25 — Chris Marusich 9 years ago d922c8e
monads, doc: Improve mwhen and munless documentation.

* doc/guix.texi (The Store Monad) <mwhen, munless>: Document them.
* guix/monads.scm (mwhen, munless): Clarify their intended use.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2 files changed, 22 insertions(+), 4 deletions(-)

M doc/guix.texi
M guix/monads.scm
M doc/guix.texi => doc/guix.texi +14 -0
@@ 4054,6 4054,20 @@ monadic expressions are ignored.  In that sense, it is analogous to
@code{begin}, but applied to monadic expressions.
@end deffn

@deffn {Scheme System} mwhen @var{condition} @var{mexp0} @var{mexp*} ...
When @var{condition} is true, evaluate the sequence of monadic
expressions @var{mexp0}..@var{mexp*} as in an @code{mbegin}.  When
@var{condition} is false, return @code{*unspecified*} in the current
monad.  Every expression in the sequence must be a monadic expression.
@end deffn

@deffn {Scheme System} munless @var{condition} @var{mexp0} @var{mexp*} ...
When @var{condition} is false, evaluate the sequence of monadic
expressions @var{mexp0}..@var{mexp*} as in an @code{mbegin}.  When
@var{condition} is true, return @code{*unspecified*} in the current
monad.  Every expression in the sequence must be a monadic expression.
@end deffn

@cindex state monad
The @code{(guix monads)} module provides the @dfn{state monad}, which
allows an additional value---the state---to be @emph{threaded} through

M guix/monads.scm => guix/monads.scm +8 -4
@@ 204,8 204,10 @@ the last one."

(define-syntax mwhen
  (syntax-rules ()
    "When CONDITION is true, evaluate MEXP0..MEXP* as in an 'mbegin'.  When
CONDITION is false, return *unspecified* in the current monad."
    "When CONDITION is true, evaluate the sequence of monadic expressions
MEXP0..MEXP* as in an 'mbegin'.  When CONDITION is false, return *unspecified*
in the current monad.  Every expression in the sequence must be a monadic
expression."
    ((_ condition mexp0 mexp* ...)
     (if condition
         (mbegin %current-monad


@@ 214,8 216,10 @@ CONDITION is false, return *unspecified* in the current monad."

(define-syntax munless
  (syntax-rules ()
    "When CONDITION is false, evaluate MEXP0..MEXP* as in an 'mbegin'.  When
CONDITION is true, return *unspecified* in the current monad."
    "When CONDITION is false, evaluate the sequence of monadic expressions
MEXP0..MEXP* as in an 'mbegin'.  When CONDITION is true, return *unspecified*
in the current monad.  Every expression in the sequence must be a monadic
expression."
    ((_ condition mexp0 mexp* ...)
     (if condition
         (return *unspecified*)