diff --git a/basis/changer/changer-docs.factor b/basis/changer/changer-docs.factor new file mode 100644 index 0000000000..5fe24b922f --- /dev/null +++ b/basis/changer/changer-docs.factor @@ -0,0 +1,38 @@ +! Copyright (C) 2015 Doug Coleman. +! See http://factorcode.org/license.txt for BSD license. +USING: help.markup help.syntax kernel quotations strings ; +IN: changer + +HELP: change: +{ $description "Syntax word for applying a quotation to a tuple slot." } +{ $examples + "Change a tuple slot:" + { $example + "USING: prettyprint changer kernel math ;" + "IN: changer" + "TUPLE: nightclub count ;" + "T{ nightclub f 0 } [ 3 + ] change: count ." + "T{ nightclub { count 3 } }" + } +} ; + +HELP: inline-changer +{ $values + { "name" string } + { "quot'" quotation } +} +{ $description "A macro that takes a slot name and applies the quotation to a slot of a tuple." } ; + +ARTICLE: "changer" "Changer syntax" +"The " { $vocab-link "changer" } " vocabulary defines one word to change the values of a slot of tuple objects." +$nl +"Syntax word to change tuple slots:" +{ $subsections + POSTPONE: change: +} +"Macro to implement " { $link POSTPONE: change: } ":" +{ $subsections + inline-changer +} ; + +ABOUT: "changer"