]> gitweb.factorcode.org Git - factor.git/blobdiff - basis/concurrency/futures/futures-docs.factor
core, basis, extra: Remove DOS line endings from files.
[factor.git] / basis / concurrency / futures / futures-docs.factor
index 56f8c73237cf43c430eebaef08b0de62fd6b776b..2aae2b4aec6f782af55b382e3afb383dd0a30c35 100644 (file)
@@ -1,31 +1,31 @@
-! Copyright (C) 2005, 2008 Chris Double, Slava Pestov.\r
-! See http://factorcode.org/license.txt for BSD license.\r
-USING: concurrency.promises concurrency.messaging kernel arrays\r
-continuations help.markup help.syntax quotations calendar ;\r
-IN: concurrency.futures\r
-\r
-HELP: future\r
-{ $values { "quot" { $quotation ( -- value ) } } { "future" future } }\r
-{ $description "Creates a deferred computation."\r
-$nl\r
-"The quotation begins with an empty data stack, an empty catch stack, and a name stack containing the global namespace only. This means that the only way to pass data to the quotation is to partially apply the data, for example using " { $link curry } " or " { $link compose } "." } ;\r
-\r
-HELP: ?future-timeout\r
-{ $values { "future" future } { "timeout" { $maybe duration } } { "value" object } }\r
-{ $description "Waits for a deferred computation to complete, blocking indefinitely if " { $snippet "timeout" } " is " { $link f } ", otherwise waiting up to the " { $snippet "timeout" } " before throwing an error." }\r
-{ $errors "Throws an error if the timeout expires before the computation completes. Also throws an error if the future quotation threw an error." } ;\r
-\r
-HELP: ?future\r
-{ $values { "future" future } { "value" object } }\r
-{ $description "Waits for a deferred computation to complete, blocking indefinitely." }\r
-{ $errors "Throws an error if future quotation threw an error." } ;\r
-\r
-ARTICLE: "concurrency.futures" "Futures"\r
-"The " { $vocab-link "concurrency.futures" } " vocabulary implements " { $emphasis "futures" } ", which are deferred computations performed in a background thread. A thread may create a future, then proceed to perform other tasks, then later wait for the future to complete."\r
-{ $subsections\r
-    future\r
-    ?future\r
-    ?future-timeout\r
-} ;\r
-\r
-ABOUT: "concurrency.futures"\r
+! Copyright (C) 2005, 2008 Chris Double, Slava Pestov.
+! See http://factorcode.org/license.txt for BSD license.
+USING: concurrency.promises concurrency.messaging kernel arrays
+continuations help.markup help.syntax quotations calendar ;
+IN: concurrency.futures
+
+HELP: future
+{ $values { "quot" { $quotation ( -- value ) } } { "future" future } }
+{ $description "Creates a deferred computation."
+$nl
+"The quotation begins with an empty data stack, an empty catch stack, and a name stack containing the global namespace only. This means that the only way to pass data to the quotation is to partially apply the data, for example using " { $link curry } " or " { $link compose } "." } ;
+
+HELP: ?future-timeout
+{ $values { "future" future } { "timeout" { $maybe duration } } { "value" object } }
+{ $description "Waits for a deferred computation to complete, blocking indefinitely if " { $snippet "timeout" } " is " { $link f } ", otherwise waiting up to the " { $snippet "timeout" } " before throwing an error." }
+{ $errors "Throws an error if the timeout expires before the computation completes. Also throws an error if the future quotation threw an error." } ;
+
+HELP: ?future
+{ $values { "future" future } { "value" object } }
+{ $description "Waits for a deferred computation to complete, blocking indefinitely." }
+{ $errors "Throws an error if future quotation threw an error." } ;
+
+ARTICLE: "concurrency.futures" "Futures"
+"The " { $vocab-link "concurrency.futures" } " vocabulary implements " { $emphasis "futures" } ", which are deferred computations performed in a background thread. A thread may create a future, then proceed to perform other tasks, then later wait for the future to complete."
+{ $subsections
+    future
+    ?future
+    ?future-timeout
+} ;
+
+ABOUT: "concurrency.futures"