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

sequences.abbrev: add docs - not much, but a start

db4
Maximilian Lupke 2009-07-21 00:37:45 +02:00
parent ea7cbd2b5a
commit 08814c3308
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
extra/sequences/abbrev/abbrev-docs.factor Normal file
View File

@ -0,0 +1,28 @@
! Copyright (C) 2009 Maximilian Lupke.
! See http://factorcode.org/license.txt for BSD license.
USING: assocs help.markup help.syntax sequences ;
IN: sequences.abbrev
HELP: abbrev
{ $values
{ "seqs" sequence }
{ "assoc" assoc }
}
{ $description "Calculates an assoc of { prefix sequence } pairs with prefix being an prefix of each element of sequence for each element in " { $snippet "seqs" } "." } ;
HELP: unique-abbrev
{ $values
{ "seqs" sequence }
{ "assoc" assoc }
}
{ $description "Calculates an assoc of { prefix { sequence } } pairs with prefix being an unambiguous prefix of sequence in seqs." } ;
ARTICLE: "sequences.abbrev" "Examples of abbrev usage"
"It is probably easiest to just run examples to understand abbrev."
{ $code
"{ \"hello\" \"help\" } abbrev"
"{ \"hello\" \"help\" } unique-abbrev"
}
;
ABOUT: "sequences.abbrev"