steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix some minor errors in help-lint.

db4
John Benediktsson 2015-01-30 13:34:37 -08:00
parent 5e01164a72
commit ac23acc2c9
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
basis/math/statistics/statistics-docs.factor
View File

@ -1,5 +1,5 @@
USING: assocs debugger hashtables help.markup help.syntax USING: assocs debugger hashtables help.markup help.syntax
quotations sequences math ; kernel quotations sequences math ;
IN: math.statistics IN: math.statistics
HELP: geometric-mean HELP: geometric-mean
@ -16,9 +16,9 @@ HELP: harmonic-mean
{ $errors "Throws a " { $link signal-error. } " (divide by zero) if the sequence is empty." } ; { $errors "Throws a " { $link signal-error. } " (divide by zero) if the sequence is empty." } ;
HELP: kth-smallest HELP: kth-smallest
{ $values { "seq" sequence } { "k" integer } } { $values { "seq" sequence } { "k" integer } { "elt" object } }
{ $description "Returns the kth smallest element. This is semantically equivalent to " { $snippet "swap natural-sort nth" } ", and is therefore zero-indexed. " { $snippet "k" } " may not be larger than the highest index of " { $snippet "sequence" } "." } { $description "Returns the kth smallest element. This is semantically equivalent to " { $snippet "swap natural-sort nth" } ", and is therefore zero-indexed. " { $snippet "k" } " may not be larger than the highest index of " { $snippet "sequence" } "." }
{ $examples { $example "USING: math.statistics ;" "{ 3 1 2 } 1 kth-smallest ." "2" } } ; { $examples { $example "USING: math.statistics prettyprint ;" "{ 3 1 2 } 1 kth-smallest ." "2" } } ;
HELP: mean HELP: mean
{ $values { "seq" sequence } { "x" "a non-negative real number"} } { $values { "seq" sequence } { "x" "a non-negative real number"} }

10
extra/sequences/extras/extras-docs.factor
View File

@ -1,4 +1,4 @@
USING: help.markup help.syntax math sequences ; USING: help.markup help.syntax kernel math sequences ;
IN: sequences.extras IN: sequences.extras
HELP: count* HELP: count*
@ -7,29 +7,31 @@ HELP: count*
{ "quot" { $quotation ( ... elt -- ... ? ) } } { "quot" { $quotation ( ... elt -- ... ? ) } }
{ "%" rational } } { "%" rational } }
{ $description "Outputs the fraction of elements in the sequence for which the predicate quotation matches." } { $description "Outputs the fraction of elements in the sequence for which the predicate quotation matches." }
{ $examples { $example "USING: math.ranges prettyprint sequences.extras ;" "100 [1,b] [ even? ] count*" "1/2" } } ; { $examples { $example "USING: math math.ranges prettyprint sequences.extras ;" "100 [1,b] [ even? ] count* ." "1/2" } } ;
HELP: collapse HELP: collapse
{ $values { $values
{ "seq" sequence } { "seq" sequence }
{ "quot" { $quotation ( ... elt -- ... ? ) } } { "quot" { $quotation ( ... elt -- ... ? ) } }
{ "elt" object }
{ "seq'" sequence } } { "seq'" sequence } }
{ $description "Generate a new sequence where all runs of elements for which the predicate returns true are replaced by a single instance of " { $snippet "elt" } "." } { $description "Generate a new sequence where all runs of elements for which the predicate returns true are replaced by a single instance of " { $snippet "elt" } "." }
{ $see-also compact } { $see-also compact }
{ $examples { $examples
"Collapse multiple spaces in a string down to a single space" "Collapse multiple spaces in a string down to a single space"
{ $example "USING: sequences.extras ;" "\" Hello, crazy world \" [ CHAR: \\s = ] \" \" collapse" "\" Hello, crazy world \"" } } ; { $example "USING: kernel prettyprint sequences.extras ;" "\" Hello, crazy world \" [ CHAR: \\s = ] \" \" collapse ." "\" Hello, crazy world \"" } } ;
HELP: compact HELP: compact
{ $values { $values
{ "seq" sequence } { "seq" sequence }
{ "quot" { $quotation ( ... elt -- ... ? ) } } { "quot" { $quotation ( ... elt -- ... ? ) } }
{ "elt" object }
{ "seq'" sequence } } { "seq'" sequence } }
{ $description "Generate a new sequence where all runs of elements for which the predicate returns true are replaced by a single instance of " { $snippet "elt" } ". Runs at the beginning or end of the sequence for which the predicate returns true are removed." } { $description "Generate a new sequence where all runs of elements for which the predicate returns true are replaced by a single instance of " { $snippet "elt" } ". Runs at the beginning or end of the sequence for which the predicate returns true are removed." }
{ $see-also collapse } { $see-also collapse }
{ $examples { $examples
"Collapse multiple spaces in a string down to a single space" "Collapse multiple spaces in a string down to a single space"
{ $example "USING: sequences.extras ;" "\" Hello, crazy world \" [ CHAR: \\s = ] \" \" compact" "\"Hello, crazy world\"" } } ; { $example "USING: kernel prettyprint sequences.extras ;" "\" Hello, crazy world \" [ CHAR: \\s = ] \" \" compact ." "\"Hello, crazy world\"" } } ;
HELP: combos HELP: combos
{ $values { $values