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

YAML: better docs for >yaml, typos

db4
Jon Harper 2014-05-21 22:54:46 +02:00 committed by John Benediktsson
parent bf737f3672
commit 712d6bf1c8
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
extra/yaml/yaml-docs.factor
View File

@ -17,21 +17,31 @@ HELP: >yaml-docs
{ "seq" sequence } { "seq" sequence }
{ "str" string } { "str" string }
} }
{ $description "Serializes the sequence into a YAML formatted string. Each element is outputted as a YAML document" } ; { $description "Serializes the sequence into a YAML formatted string. Each element is outputted as a YAML document." } ;
HELP: yaml-docs> HELP: yaml-docs>
{ $values { $values
{ "str" string } { "str" string }
{ "arr" array } { "arr" array }
} }
{ $description "Deserializes the YAML formatted string into a Factor array. Each document becomes an element of the array" } ; { $description "Deserializes the YAML formatted string into a Factor array. Each document becomes an element of the array." } ;
HELP: yaml> HELP: yaml>
{ $values { $values
{ "str" string } { "str" string }
{ "obj" object } { "obj" object }
} }
{ $description "Deserializes the YAML formatted string into a Factor object." } ; { $description "Deserializes the YAML formatted string into a Factor object. Throws "
{ $link yaml-no-document } " when there is no document (for example the empty string)."
$nl
}
{ $notes
"Contrary to " { $link yaml-docs> } ", this word only parses the input until one document is produced."
" Valid or invalid content after the first document is ignored."
" To verifiy that the whole input is one valid YAML document, use "
{ $link yaml-docs> } " and assert that the length of the output array is 1."
}
;
HELP: libyaml-emitter-error HELP: libyaml-emitter-error
{ $values { $values