]> gitweb.factorcode.org Git - factor.git/commitdiff
Docs for http-data
authorDoug Coleman <doug.coleman@gmail.com>
Fri, 26 Feb 2010 00:07:14 +0000 (18:07 -0600)
committerDoug Coleman <doug.coleman@gmail.com>
Sat, 27 Feb 2010 13:58:37 +0000 (07:58 -0600)
basis/http/client/client-docs.factor

index 04077fc2f7b0369b4cab6750041a1e57de778f6a..0d0887d10d80ce2e457c85f34d62ca75150644f3 100644 (file)
@@ -35,6 +35,11 @@ HELP: http-get
 { $description "Downloads the contents of a URL." }
 { $errors "Throws an error if the HTTP request fails." } ;
 
+HELP: http-data
+{ $values { "url" "a " { $link url } " or " { $link string } } { "data" sequence } }
+{ $description "Downloads the contents of a URL. To view the HTTP response, use " { $link http-get } "." }
+{ $errors "Throws an error if the HTTP request fails." } ;
+
 HELP: http-post
 { $values { "post-data" object } { "url" "a " { $link url } " or " { $link string } } { "response" response } { "data" sequence } }
 { $description "Submits an HTTP POST request." }
@@ -61,7 +66,7 @@ HELP: with-http-request
 
 ARTICLE: "http.client.get" "GET requests with the HTTP client"
 "Basic usage involves passing a " { $link url } " and getting a " { $link response } " and data back:"
-{ $subsections http-get }
+{ $subsections http-get http-data }
 "Utilities to retrieve a " { $link url } " and save the contents to a file:"
 { $subsections
     download