Changeset 3291

Timestamp:

05/16/05 14:58:37 (4 years ago)

Author:

scook0

svk:copy_cache_prev:

4878

Message:

Revised Haddocks for Monads.hs

Files:

• src/Pugs/Monads.hs (modified) (2 diffs)

src/Pugs/Monads.hs

@@ -19 +19 @@
 import Pugs.Types
 
--- |Perform the specified evaluation in a lexical scope that has been
--- augmented by the given list of lexical 'Pad' transformers. Subsequent
--- chained 'Eval's do /not/ see this new scope.
+{-|
+Create a new lexical scope by applying the list of 'Pad'-transformers
+(which install new bindings), then perform the specified evaluation in that
+new scope.
+
+(Subsequent chained 'Eval's do /not/ see this new scope.)
+-}
 enterLex :: [Pad -> Pad] -- ^ Transformations on current 'Pad' to produce the
                          --     new 'Pad'.
@@ -29 +33 @@
 enterLex newSyms = local (\e -> e{ envLexical = combine newSyms (envLexical e) })
 
--- |Perform the specified evaluation in the specified context ('Cxt').
--- Subsequent chained 'Eval's do /not/ see this new scope.
+{-|
+Perform the specified evaluation in the specified (Perl6) context ('Cxt').
+
+(Subsequent chained 'Eval's do /not/ see this new scope.)
+-}
 enterContext :: Cxt -> Eval a -> Eval a
 enterContext cxt = local (\e -> e{ envContext = cxt })
 
--- |Bind @\$_@ to the given topic value in a new lexical scope, then perform
--- the given evaluation in that scope. Used by "Pugs.Eval"'s implementation
--- of 'Pugs.Eval.reduce' for @\"given\"@.
+{-|
+Bind @\$_@ to the given topic value in a new lexical scope, then perform
+the specified evaluation in that scope.
+
+Used by "Pugs.Eval"'s implementation of 'Pugs.Eval.reduce' for @\"given\"@.
+-}
 enterGiven :: VRef   -- ^ Reference to the value to topicalise
            -> Eval a -- ^ Action to perform within the new scope