Merge branch 'master' of git://factorcode.org/git/factor
[factor/jcg.git] / basis / csv / csv-docs.factor
blobe4741f4810c97367c36df4285a9ca78640dbdb5e
1 USING: help.syntax help.markup kernel prettyprint sequences ;
2 IN: csv
4 HELP: csv
5 { $values { "stream" "an input stream" }
6           { "rows" "an array of arrays of fields" } } 
7 { $description "parses a csv stream into an array of row arrays"
8 } ;
10 HELP: csv-row
11 { $values { "stream" "an input stream" }
12           { "row" "an array of fields" } } 
13 { $description "parses a row from a csv stream"
14 } ;
16 HELP: write-csv
17 { $values { "rows" "an sequence of sequences of strings" }
18           { "stream" "an output stream" } } 
19 { $description "writes csv to the output stream, escaping where necessary"
20 } ;
23 HELP: with-delimiter
24 { $values { "char" "field delimiter (e.g. CHAR: \t)" }
25           { "quot" "a quotation" } }
26 { $description "Sets the field delimiter for csv or csv-row words "
27 } ;