From 67ed236225287d67f6e4059686945bc4b35d72a2 Mon Sep 17 00:00:00 2001 From: AJ Rossini Date: Wed, 11 Mar 2009 16:38:34 +0100 Subject: [PATCH] documentation for how I want the example/illustration function to work, and the Signed-off-by: AJ Rossini --- README | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README b/README index aa895ea..0d09d93 100644 --- a/README +++ b/README @@ -136,3 +136,23 @@ account and work from there. In that case, you'd need to D/L the libraries. That gets a bit tricky, but see ./bin/GetRepos.sh for an example. + +=========== + +I've started putting examples of use in function documentation. If +you are a lisp'er, you'll find this pendantic and insulting. Many of +the uses are trivial. However, this has been tested out on a number +of research statisticians (the primary user audience) and found +useful. + +Still need to write the (run-doc-ex 'function-name) function, which +would print out the example and run it live. Hopefully with the same +results. I've used XML markup for this, but for no particular reason, +we could have used SEXPs as well. This is currently done by using an + tag set, as in + + (progn + (example-code-for-function)) + + +=========== -- 2.11.4.GIT