]> gitweb.factorcode.org Git - factor.git/commitdiff
Fixing docs for recent stack effects additions.
authorJohn Benediktsson <mrjbq7@gmail.com>
Sun, 25 Sep 2011 05:08:54 +0000 (22:08 -0700)
committerJohn Benediktsson <mrjbq7@gmail.com>
Sun, 25 Sep 2011 05:08:54 +0000 (22:08 -0700)
basis/grouping/grouping-docs.factor
basis/grouping/grouping.factor
basis/threads/threads-docs.factor
core/sorting/sorting-docs.factor
core/splitting/splitting-docs.factor

index 44da43a76b88157715631b30b0229efe82bc33c5..2b183c3364893a5900586852c5c8090d2c0284c0 100644 (file)
@@ -181,7 +181,7 @@ HELP: <sliced-circular-clumps>
 { <sliced-clumps> <sliced-circular-clumps> <sliced-groups> } related-words
 
 HELP: monotonic?
-{ $values { "seq" sequence } { "quot" { $quotation "( elt elt -- ? )" } } { "?" "a boolean" } }
+{ $values { "seq" sequence } { "quot" { $quotation "( elt1 elt2 -- ? )" } } { "?" "a boolean" } }
 { $description "Applies the relation to successive pairs of elements in the sequence, testing for a truth value. The relation should be a transitive relation, such as a total order or an equality relation." }
 { $examples
     "Testing if a sequence is non-decreasing:"
index 1b2563992d727adc0acc90d8e0fcafe4a73d63d0..09e87698cf4d3bc1ea571f428dc5afc55ee1317a 100644 (file)
@@ -99,7 +99,7 @@ INSTANCE: sliced-clumps abstract-clumps
 
 : clump ( seq n -- array ) <clumps> { } like ;
 
-: monotonic? ( seq quot: ( obj1 obj2 -- ? ) -- ? )
+: monotonic? ( seq quot: ( elt1 elt2 -- ? ) -- ? )
     over length 2 < [ 2drop t ] [
         over length 2 = [
             [ first2-unsafe ] dip call
index 3e63a81d9abaf326445d879fd869b420751b188a..563a59dde9ea0316a9a52fce951938bc213e6243 100644 (file)
@@ -181,5 +181,5 @@ HELP: tset
 { $description "Sets the value of a thread-local variable." } ;
 
 HELP: tchange
-{ $values { "key" object } { "quot" { $quotation "( value -- newvalue )" } } }
+{ $values { "key" object } { "quot" { $quotation "( ..a value -- ..b newvalue )" } } }
 { $description "Applies the quotation to the current value of a thread-local variable, storing the result back to the same variable." } ;
index 4877cdf4100df4ffa855c8b49a19dbe360fbe965..6bff4281c926bfe873b0b3788653dae2b2ec4e37 100644 (file)
@@ -28,11 +28,11 @@ HELP: sort
 { $notes "The algorithm used is the merge sort." } ;
 
 HELP: sort-with
-{ $values { "seq" "a sequence" } { "quot" { $quotation "( object -- key )" } } { "sortedseq" "a new sorted sequence" } }
+{ $values { "seq" "a sequence" } { "quot" { $quotation "( elt -- key )" } } { "sortedseq" "a new sorted sequence" } }
 { $description "Sorts the elements of " { $snippet "seq" } " by applying " { $link compare } " with " { $snippet "quot" } " to each pair of elements in the sequence." } ;
 
 HELP: inv-sort-with
-{ $values { "seq" "a sequence" } { "quot" { $quotation "( object -- key )" } } { "sortedseq" "a new sorted sequence" } }
+{ $values { "seq" "a sequence" } { "quot" { $quotation "( elt -- key )" } } { "sortedseq" "a new sorted sequence" } }
 { $description "Sorts the elements of " { $snippet "seq" } " by applying " { $link compare } " with " { $snippet "quot" } " to each pair of elements in the sequence and inverting the results." } ;
 
 HELP: sort-keys
index 50855713121181367d318f1c2bb49efafce9ce1c..0e8e3928798b8ae054dd03a2392daf42afafa3a7 100644 (file)
@@ -39,7 +39,7 @@ HELP: split1-last-slice
 { split1 split1-slice split1-last split1-last-slice } related-words
 
 HELP: split-when
-{ $values { "seq" "a sequence" } { "quot" { $quotation "( elt -- ? )" } } { "pieces" "a new array" } }
+{ $values { "seq" "a sequence" } { "quot" { $quotation "( ... elt -- ... ? )" } } { "pieces" "a new array" } }
 { $description "Splits " { $snippet "seq" } " at each occurrence of an element for which " { $snippet "quot" } " gives a true output and outputs an array of pieces. The pieces do not include the elements along which the sequence was split." }
 { $examples { $example "USING: ascii kernel prettyprint splitting ;" "\"hello,world-how.are:you\" [ letter? not ] split-when ." "{ \"hello\" \"world\" \"how\" \"are\" \"you\" }" } } ;