lib/ruote/exp/fe_forget.rb in ruote-2.2.0 vs lib/ruote/exp/fe_forget.rb in ruote-2.3.0

@@ -1,7 +1,7 @@
 #--
-# Copyright (c) 2005-2011, John Mettraux, [e-mail]
+# Copyright (c) 2005-2012, John Mettraux, [e-mail]
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
@@ -55,17 +55,34 @@
   #       participant 'charly'
   #     end
   #     participant 'delta'
   #   end
   #
-  # This expression can be useful for fire-and-forget parallelism in processes.
+  # This expression can be useful for fire-and-forget 'parallelism'
+  # in processes.
   #
-  # == forget vs lose
   #
+  # == multi forget
+  #
+  # Forget multiple children at once.
+  #
+  #   forget do
+  #     alice :task => 'take out garbage'
+  #     bob :task => 'clean living room'
+  #   end
+  #
+  # The forget expression will reply immediately to its parent expression, it
+  # will thus not be cancellable (neither the children will be cancellable).
+  #
+  #
+  # == forget vs lose vs flank
+  #
   # forget : replies to parent expression immediately, is not cancellable
   # (not reachable).
   #
-  # lose : never replies to parent expression, is cancellable.
+  # lose : never replies to the parent expression, is cancellable.
+  #
+  # flank : immediately replies to the parent expression, is cancellable.
   #
   class ForgetExpression < FlowExpression
 
     names :forget