Add documentation for lots of the "undocumented" bits
All checks were successful
/ test (push) Successful in 6s

In the Guile Documenta generated documentation.
This commit is contained in:
Christopher Baines 2026-03-23 11:56:53 +00:00
parent d282841a78
commit d0ff89023b
8 changed files with 140 additions and 5 deletions

View file

@ -95,6 +95,8 @@ If THUNK raises an exception it is re-raised in the calling fiber."
(define port-timeout-error?
(exception-predicate &port-timeout-error))
(set-procedure-property! port-timeout-error? 'documentation
"Return @code{#t} if OBJ is a @code{&port-timeout-error}.")
(define &port-read-timeout-error
(make-exception-type '&port-read-timeout-error
@ -106,6 +108,8 @@ If THUNK raises an exception it is re-raised in the calling fiber."
(define port-read-timeout-error?
(exception-predicate &port-read-timeout-error))
(set-procedure-property! port-read-timeout-error? 'documentation
"Return @code{#t} if OBJ is a @code{&port-read-timeout-error}.")
(define &port-write-timeout-error
(make-exception-type '&port-write-timeout-error
@ -117,6 +121,8 @@ If THUNK raises an exception it is re-raised in the calling fiber."
(define port-write-timeout-error?
(exception-predicate &port-write-timeout-error))
(set-procedure-property! port-write-timeout-error? 'documentation
"Return @code{#t} if OBJ is a @code{&port-write-timeout-error}.")
(define (readable? port)
"Test if PORT is readable."