diff --git a/extra/io/ports/ports-docs.factor b/extra/io/ports/ports-docs.factor index 38e9da2d56..7420cac115 100755 --- a/extra/io/ports/ports-docs.factor +++ b/extra/io/ports/ports-docs.factor @@ -62,8 +62,8 @@ HELP: (wait-to-read) { $contract "Suspends the current thread until the port's buffer has data available for reading." } ; HELP: wait-to-read -{ $values { "port" input-port } } -{ $description "If the port's buffer has unread data, returns immediately, otherwise suspends the current thread until some data is available for reading." } ; +{ $values { "port" input-port } { "eof?" "a boolean" } } +{ $description "If the port's buffer has unread data, returns immediately, otherwise suspends the current thread until some data is available for reading. If the buffer was empty and no more data could be read, outputs " { $link t } " to indicate end-of-file; otherwise outputs " { $link f } "." } ; HELP: can-write? { $values { "len" "a positive integer" } { "buffer" buffer } { "?" "a boolean" } }