From be06663629def065abe5e4e827f1f7d6c92085f0 Mon Sep 17 00:00:00 2001 From: James Cash Date: Thu, 15 May 2008 21:21:33 -0400 Subject: [PATCH] Writing docs for lisp and lisp.parser --- extra/lisp/lisp-docs.factor | 15 +++++++++++++++ extra/lisp/parser/parser-docs.factor | 6 ++++++ 2 files changed, 21 insertions(+) create mode 100644 extra/lisp/lisp-docs.factor create mode 100644 extra/lisp/parser/parser-docs.factor diff --git a/extra/lisp/lisp-docs.factor b/extra/lisp/lisp-docs.factor new file mode 100644 index 0000000000..149f22864e --- /dev/null +++ b/extra/lisp/lisp-docs.factor @@ -0,0 +1,15 @@ +IN: lisp +USING: help.markup help.syntax ; + +ARTICLE: "lisp" "Lisp in Factor" +"This is a simple implementation of a Lisp dialect, which somewhat resembles Scheme." $nl +"It works in two main stages: " +{ $list + { "Parse (via " { $vocab-link "lisp.parser" } " the Lisp code into a " + { $snippet "s-exp" } " tuple." } + { "Transform the " { $snippet "s-exp" } " into a Factor quotation, via " { $link convert-form } } +} + +{ $subsection "lisp.parser" } ; + +ABOUT: "lisp" \ No newline at end of file diff --git a/extra/lisp/parser/parser-docs.factor b/extra/lisp/parser/parser-docs.factor new file mode 100644 index 0000000000..fc16a0a310 --- /dev/null +++ b/extra/lisp/parser/parser-docs.factor @@ -0,0 +1,6 @@ +IN: lisp.parser +USING: help.markup help.syntax ; + +ARTICLE: "lisp.parser" "Parsing strings of Lisp" +"This vocab uses " { $vocab-link "peg.ebnf" } " to turn strings of Lisp into " { $snippet "s-exp" } "s, which are then used by" +{ $vocab-link "lisp" } " to produce Factor quotations." ; \ No newline at end of file