]> gitweb.factorcode.org Git - factor.git/commitdiff
io: improve docs for stream-copy*.
authorJohn Benediktsson <mrjbq7@gmail.com>
Tue, 14 Aug 2012 22:12:19 +0000 (15:12 -0700)
committerJohn Benediktsson <mrjbq7@gmail.com>
Tue, 14 Aug 2012 22:12:19 +0000 (15:12 -0700)
core/io/io-docs.factor

index 5d0f0018facfcfcb3c89eb57e488bed4b8800587..bfa16e4ed728e485835d0a159608cc99c9a66bfe 100644 (file)
@@ -123,7 +123,7 @@ $io-error ;
 
 HELP: stream-copy*
 { $values { "in" "an input stream" } { "out" "an output stream" } }
-{ $description "Copies the contents of one stream into another. The streams are left open when the copy is completed." { $link stream-copy } " will copy the streams and close them on completion." }
+{ $description "Copies the contents of one stream into another. The streams are left open when the copy is completed. The " { $link stream-copy } " word can be used instead to close them on completion, if desired." }
 $io-error ;
 
 HELP: stream-copy