]> gitweb.factorcode.org Git - factor.git/commitdiff
assocs: improve stack effect docs for "?at".
authorJohn Benediktsson <mrjbq7@gmail.com>
Mon, 26 Sep 2011 18:32:20 +0000 (11:32 -0700)
committerJohn Benediktsson <mrjbq7@gmail.com>
Mon, 26 Sep 2011 18:32:20 +0000 (11:32 -0700)
core/assocs/assocs-docs.factor

index 883952296f5aa7a5915437dc9580885e14947890..43ac635666abd0b9c2b3cdeb9b4d7db3399fa092 100644 (file)
@@ -189,7 +189,7 @@ HELP: assoc
 } ;
 
 HELP: at*
-{ $values { "key" "an object to look up in the assoc" } { "assoc" assoc } { "value/f" "the value associated to the key, or " { $link f } " if the key is not present in the assoc" } { "?" "a boolean indicating if the key was present" } }
+{ $values { "key" "an object to look up in the assoc" } { "assoc" assoc } { "value/f" "the value associated to the key, or " { $link f } " if the key is not present in the assoc" } { "?" "a " { $link boolean } " indicating if the key was present" } }
 { $contract "Looks up the value associated with a key. The boolean flag can decide between the case of a missing value, and a value of " { $link f } "." } ;
 
 HELP: set-at
@@ -238,7 +238,7 @@ HELP: at
 { $description "Looks up the value associated with a key. This word makes no distinction between a missing value and a value set to " { $link f } "; if the difference is important, use " { $link at* } "." } ;
 
 HELP: ?at
-{ $values { "key" object } { "assoc" assoc } { "value/key" "the value associated to the key, or the key if the key is not present in the assoc" } { "?" boolean } }
+{ $values { "key" object } { "assoc" assoc } { "value/key" "the value associated to the key, or the key if the key is not present in the assoc" } { "?" "a " { $link boolean } " indicating if the key was present" } }
 { $description "Looks up the value associated with a key. If the key was not present, an error can be thrown without extra stack shuffling. This word handles assocs that store " { $link f } "." } ;
 
 HELP: assoc-each