Changeset 3569 for src/Pugs/Junc.hs

Timestamp:

05/21/05 10:53:05 (4 years ago)

Author:

scook0

svk:copy_cache_prev:

5154

Message:

Tweaks to Haddocks for Junc.hs

Files:

• src/Pugs/Junc.hs (modified) (3 diffs)

src/Pugs/Junc.hs

@@ -64 +64 @@
 
 {-|
-Check if the specified value is a 'VJunc' of one of the specified
-junctive types. If it is, return it as a 'VJunc'.
+Check if the specified value is a 'Pugs.Internals.VJunc' of one of the specified
+junctive types. If it is, return it as a 'Pugs.Internals.VJunc'.
 -}
 juncTypeIs :: Val -- ^ Value to test
@@ -81 +81 @@
 junction value.
 
-For 'JAny', values are simply collapsed into @Set@s (duplicate values are
-discarded).
-
-For 'JOne', newly-created duplicates are extracted from the combined list of
-values and moved into the combined set of duplicates.
+For 'Pugs.Internals.JAny', values are simply collapsed into @Set@s (duplicate
+values are discarded).
+
+For 'Pugs.Internals.JOne', newly-created duplicates are extracted from the 
+combined list of values and moved into the combined set of duplicates.
 -}
 mergeJunc :: JuncType -- ^ Type of the junctions being combined
@@ -107 +107 @@
 Core of the \"hideously clever\" autothreading algorithm.
 
-This function scans through the list of 'ApplyArg's, finds any that are
-uncollapsed junctions, and transposes the \'sub call with junction argument\'
-into \'junction of sub calls with non-junction arguments\'. It then recursively
-applies itself to each of those newly-created \'threads\', so ultimately all
-the call's arguments are properly collapsed.
+This function scans through the list of 'ApplyArg's, finds the first
+uncollapsed junction, and transposes e.g. @foo($a|$b|$c)@ into
+@( foo($a) | foo($b) | foo($c) )@.
+
+It then recursively applies itself to each of those newly-created \'threads\', 
+so ultimately all the call's arguments are properly collapsed.
 
 The scanning process will thread through @all@ and @none@ before it threads
 through @any@ and @one@.
 
-Once all the args /are/ collapsed, we call our first argument with the final,
-collapsed args. This happens once for each possible combination of (collapsed)
-arguments.
+Once all the args /are/ collapsed, we call the (Haskell) function that 
+'juncApply'\'s was given, passing to it the final list of collapsed args.
+This happens once for /each/ possible combination of (collapsed) arguments.
+The function is expected to perform the actual subroutine call.
 
 Note that 'juncApply' takes place /after/ parameter binding (because it must),
-but /before/ we actually introduce any bindings into the sub's lexical scope.
+but /before/ we actually introduce any bindings into the sub's lexical scope
+(because otherwise we wouldn't know which value to bind).
 -}
 juncApply :: ([ApplyArg] -> Eval Val) -- ^ Function to call once we know the