From 60a9fcb1377e4acc78a930904ef80b69a1c63f25 Mon Sep 17 00:00:00 2001 From: Chris Marusich Date: Thu, 6 Apr 2017 02:28:35 -0700 Subject: monads, doc: Improve mwhen and munless documentation. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * doc/guix.texi (The Store Monad) : Document them. * guix/monads.scm (mwhen, munless): Clarify their intended use. Signed-off-by: Ludovic Courtès --- guix/monads.scm | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'guix') diff --git a/guix/monads.scm b/guix/monads.scm index 6933f7f151..fe3d5d78f1 100644 --- a/guix/monads.scm +++ b/guix/monads.scm @@ -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*) -- cgit v1.2.3