]> gitweb.factorcode.org Git - factor.git/commitdiff
Fixing docs for lists
authorJames Cash <james.nvc@gmail.com>
Thu, 5 Jun 2008 22:53:58 +0000 (18:53 -0400)
committerJames Cash <james.nvc@gmail.com>
Thu, 5 Jun 2008 22:53:58 +0000 (18:53 -0400)
extra/lists/lazy/lazy-docs.factor
extra/lists/lists-docs.factor

index 8d457ba2e1230d7699c0ad7a27934bfc620dfaa6..95e925b08964b120f234623be250c8005c2b898d 100644 (file)
@@ -127,4 +127,3 @@ HELP: llines
 { $values { "stream" "a stream" } { "result" "a list" } }
 { $description "Returns a lazy list of all lines in the file. " { $link car } " returns the next lines in the file, " { $link cdr } " returns the remaining lines as a lazy list. " { $link nil? } " indicates end of file." } 
 { $see-also lcontents } ;
-
index a5299ba6a0e0f79bc8c67bb17639255d2fa0d791..15faf8d002508b7b663fdc0c1276cec7f0234b4a 100644 (file)
@@ -19,8 +19,8 @@ HELP: cdr
 { $description "Returns the tail of the list." } ;
     
 HELP: nil 
-{ $values { "cons" "An empty cons" } }
-{ $description "Returns a representation of an empty list" } ;
+{ $values { "symbol" "The empty cons (+nil+)" } }
+{ $description "Returns a symbol representing the empty list" } ;
 
 HELP: nil? 
 { $values { "cons" "a cons object" } { "?" "a boolean" } }
@@ -85,7 +85,7 @@ HELP: list>seq
 { $description "Turns the given cons object into an array, maintaing order." } ;
     
 HELP: seq>list
-{ $values { "array" "an array object" } { "list" "a cons object" } }
+{ $values { "seq" "a sequence" } { "list" "a cons object" } }
 { $description "Turns the given array into a cons object, maintaing order." } ;
     
 HELP: cons>seq
@@ -97,7 +97,7 @@ HELP: seq>cons
 { $description "Recursively turns the given sequence into a cons object, maintaing order and also converting nested lists." } ;
     
 HELP: traverse    
-{ $values { " list"  "a cons object" } { "pred" } { "a quotation with stack effect ( list/elt -- ? )" }
+{ $values { "list"  "a cons object" } { "pred" "a quotation with stack effect ( list/elt -- ? )" }
           { "quot" "a quotation with stack effect ( list/elt -- result)" }  { "result" "a new cons object" } }
 { $description "Recursively traverses the list object, replacing any elements (which can themselves be sublists) that pred" 
     " returns true for with the result of applying quot to." } ;