]> gitweb.factorcode.org Git - factor.git/blobdiff - extra/s3/s3-docs.factor
more doc type fixes.
[factor.git] / extra / s3 / s3-docs.factor
index 6f9c10010da2d4e06031979aa53e60528f906a93..bac372bc150c6f88c771bbf078820e43084bef18 100644 (file)
@@ -1,6 +1,6 @@
 ! Copyright (C) 2009 Chris Double.\r
 ! See http://factorcode.org/license.txt for BSD license.\r
-USING: help.markup help.syntax ;\r
+USING: assocs help.markup help.syntax kernel strings ;\r
 IN: s3\r
 \r
 HELP: buckets\r
@@ -16,7 +16,7 @@ HELP: buckets
 \r
 HELP: create-bucket\r
 { $values \r
-  { "bucket" "a string" } \r
+  { "bucket" string } \r
 }\r
 { $description \r
     "Creates a bucket with the given name."\r
@@ -28,7 +28,7 @@ HELP: create-bucket
 \r
 HELP: delete-bucket\r
 { $values \r
-  { "bucket" "a string" } \r
+  { "bucket" string } \r
 }\r
 { $description \r
     "Deletes the bucket with the given name."\r
@@ -40,7 +40,7 @@ HELP: delete-bucket
 \r
 HELP: keys\r
 { $values \r
-  { "bucket" "a string" } \r
+  { "bucket" string } \r
   { "seq" "a sequence of " { $link key } " objects"} \r
 }\r
 { $description \r
@@ -53,10 +53,10 @@ HELP: keys
 \r
 HELP: get-object\r
 { $values \r
-  { "bucket" "a string" } \r
-  { "key" "a string" } \r
-  { "response" "The HTTP response object"} \r
-  { "data" "The data returned from the http request"} \r
+  { "bucket" string }\r
+  { "key" string }\r
+  { "response" "The HTTP response object"}\r
+  { "data" "The data returned from the http request"}\r
 }\r
 { $description \r
     "Does an HTTP request to retrieve the object in the bucket with the given key."\r
@@ -67,12 +67,12 @@ HELP: get-object
 ;\r
 \r
 HELP: put-object\r
-{ $values \r
-  { "data" "an object" } \r
-  { "mime-type" "a string" } \r
-  { "bucket" "a string"} \r
-  { "key" "a string"} \r
-  { "headers" "an assoc"} \r
+{ $values\r
+  { "data" object }\r
+  { "mime-type" string }\r
+  { "bucket" string }\r
+  { "key" string }\r
+  { "headers" assoc }\r
 }\r
 { $description \r
     "Stores the object under the key in the given bucket. The object has "\r
@@ -90,8 +90,8 @@ HELP: put-object
 \r
 HELP: delete-object\r
 { $values \r
-  { "bucket" "a string"} \r
-  { "key" "a string"} \r
+  { "bucket" string }\r
+  { "key" string }\r
 }\r
 { $description \r
     "Deletes the object in the bucket with the given key."\r