summaryrefslogtreecommitdiff
path: root/module/web/response.scm
diff options
context:
space:
mode:
authorDaniel Hartwig <mandyke@gmail.com>2012-11-24 14:10:12 +0800
committerLudovic Courtès <ludo@gnu.org>2012-11-24 15:40:14 +0100
commit06883ae000a65ba727f2f8debb393ffceeb4d6e9 (patch)
tree4a034ba428162b270842a90e0b40d72c0290a7cb /module/web/response.scm
parente8772a9edef3fed3c592e61bbde618de197f4b53 (diff)
downloadguile-06883ae000a65ba727f2f8debb393ffceeb4d6e9.tar.gz
syncronize web module docstrings with manual
* doc/ref/web.texi: Fix spacing. Update with a few missing function descriptions. * module/web/client.scm: * module/web/http.scm: * module/web/request.scm: * module/web/server.scm: * module/web/uri.scm: Update docstrings from manual (reworked by Ludovic Courtès).
Diffstat (limited to 'module/web/response.scm')
-rw-r--r--module/web/response.scm24
1 files changed, 12 insertions, 12 deletions
diff --git a/module/web/response.scm b/module/web/response.scm
index 6eba69d8d..aaa770792 100644
--- a/module/web/response.scm
+++ b/module/web/response.scm
@@ -107,7 +107,7 @@
(define* (build-response #:key (version '(1 . 1)) (code 200) reason-phrase
(headers '()) port (validate-headers? #t))
- "Construct an HTTP response object. If @var{validate-headers?} is true,
+ "Construct an HTTP response object. If VALIDATE-HEADERS? is true,
the headers are each run through their respective validators."
(cond
((not (and (pair? version)
@@ -170,15 +170,15 @@ the headers are each run through their respective validators."
"(Unknown)"))
(define (response-reason-phrase response)
- "Return the reason phrase given in @var{response}, or the standard
+ "Return the reason phrase given in RESPONSE, or the standard
reason phrase for the response's code."
(or (%response-reason-phrase response)
(code->reason-phrase (response-code response))))
(define (read-response port)
- "Read an HTTP response from @var{port}.
+ "Read an HTTP response from PORT.
-As a side effect, sets the encoding on @var{port} to
+As a side effect, sets the encoding on PORT to
ISO-8859-1 (latin-1), so that reading one character reads one byte. See
the discussion of character sets in \"HTTP Responses\" in the manual,
for more information."
@@ -202,10 +202,10 @@ the version field."
#:port (response-port response)))
(define (write-response r port)
- "Write the given HTTP response to @var{port}.
+ "Write the given HTTP response to PORT.
-Returns a new response, whose @code{response-port} will continue writing
-on @var{port}, perhaps using some transfer encoding."
+Returns a new response, whose ‘response-port’ will continue writing
+on PORT, perhaps using some transfer encoding."
(write-response-line (response-version r) (response-code r)
(response-reason-phrase r) port)
(write-headers (response-headers r) port)
@@ -216,7 +216,7 @@ on @var{port}, perhaps using some transfer encoding."
(response-reason-phrase r) (response-headers r) port)))
(define (response-must-not-include-body? r)
- "Returns @code{#t} if the response @var{r} is not permitted to have a body.
+ "Returns ‘#t’ if the response R is not permitted to have a body.
This is true for some response types, like those with code 304."
;; RFC 2616, section 4.3.
@@ -225,8 +225,8 @@ This is true for some response types, like those with code 304."
(= (response-code r) 304)))
(define (read-response-body r)
- "Reads the response body from @var{r}, as a bytevector. Returns
-@code{#f} if there was no response body."
+ "Reads the response body from R, as a bytevector. Returns
+‘#f’ if there was no response body."
(if (member '(chunked) (response-transfer-encoding r))
(let ((chunk-port (make-chunked-input-port (response-port r)
#:keep-alive? #t)))
@@ -240,8 +240,8 @@ This is true for some response types, like those with code 304."
(bytevector-length bv) nbytes)))))))
(define (write-response-body r bv)
- "Write @var{bv}, a bytevector, to the port corresponding to the HTTP
-response @var{r}."
+ "Write BV, a bytevector, to the port corresponding to the HTTP
+response R."
(put-bytevector (response-port r) bv))
(define-syntax define-response-accessor