mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-01 04:10:18 +02:00
Code Activity

(web uri): document that uri-port is an integer

Browse source 
* doc/ref/web.texi (URIs):
* module/web/uri.scm (build-uri): Document that uri-port is an integer.
This commit is contained in:
Daniel Hartwig 2012-11-24 15:53:34 +01:00 • committed by Ludovic Courtès
parent 06883ae000
commit 890647559d
2 changed files with 12 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/ref/web.texi
View file

@ -209,10 +209,11 @@ access to them.
@deffn {Scheme Procedure} build-uri scheme [#:userinfo=@code{#f}] [#:host=@code{#f}] @ @deffn {Scheme Procedure} build-uri scheme [#:userinfo=@code{#f}] [#:host=@code{#f}] @
[#:port=@code{#f}] [#:path=@code{""}] [#:query=@code{#f}] @ [#:port=@code{#f}] [#:path=@code{""}] [#:query=@code{#f}] @
[#:fragment=@code{#f}] [#:validate?=@code{#t}] [#:fragment=@code{#f}] [#:validate?=@code{#t}]
Construct a URI object. @var{scheme} should be a symbol, and the rest Construct a URI object. @var{scheme} should be a symbol, @var{port}
of the fields are either strings or @code{#f}. If @var{validate?} is either a positive, exact integer or @code{#f}, and the rest of the
true, also run some consistency checks to make sure that the constructed fields are either strings or @code{#f}. If @var{validate?} is true,
URI is valid. also run some consistency checks to make sure that the constructed URI
is valid.
@end deffn @end deffn
@deffn {Scheme Procedure} uri? x @deffn {Scheme Procedure} uri? x
@ -224,8 +225,8 @@ URI is valid.
@deffnx {Scheme Procedure} uri-query uri @deffnx {Scheme Procedure} uri-query uri
@deffnx {Scheme Procedure} uri-fragment uri @deffnx {Scheme Procedure} uri-fragment uri
A predicate and field accessors for the URI record type. The URI scheme A predicate and field accessors for the URI record type. The URI scheme
will be a symbol, and the rest either strings or @code{#f} if not will be a symbol, the port either a positive, exact integer or @code{#f},
present. and the rest either strings or @code{#f} if not present.
@end deffn @end deffn
@deffn {Scheme Procedure} string->uri string @deffn {Scheme Procedure} string->uri string

9
module/web/uri.scm
View file

@ -79,10 +79,11 @@
(define* (build-uri scheme #:key userinfo host port (path "") query fragment (define* (build-uri scheme #:key userinfo host port (path "") query fragment
(validate? #t)) (validate? #t))
"Construct a URI object. SCHEME should be a symbol, and the rest "Construct a URI object. SCHEME should be a symbol, PORT
of the fields are either strings or ‘#f’. If VALIDATE? is either a positive, exact integer or ‘#f’, and the rest of the
true, also run some consistency checks to make sure that the constructed fields are either strings or ‘#f’. If VALIDATE? is true,
URI is valid." also run some consistency checks to make sure that the constructed URI
is valid."
(if validate? (if validate?
(validate-uri scheme userinfo host port path query fragment)) (validate-uri scheme userinfo host port path query fragment))
(make-uri scheme userinfo host port path query fragment)) (make-uri scheme userinfo host port path query fragment))