axiom-developer
[Top][All Lists]

## [Axiom-developer] Re: Executed Examples in documentation ---> Testsuite

 From: Ralf Hemmecke Subject: [Axiom-developer] Re: Executed Examples in documentation ---> Testsuite Date: Mon, 18 Aug 2008 15:03:18 +0200 User-agent: Thunderbird 2.0.0.16 (X11/20080707)

process to filter out the ++E/++R testing syntax lines automatically.



The only thing where I am not so sure about is whether ++E/++R is the best syntax. As you may have seen in the ++ or +++ documentation, some people dont put a space after the last + so you parser might get confused.


Anyway. You remember that in ALLPROSE it don't write the ++ stuff at all. There is a LaTeX environment \begin{+++} ... \end{+++} with a certain additional structure. In particular it contains a section \begin{usage}... \end{usage} which I currently only use to list commands that show how a function is to be applied, but, of course another environment could include executable code.


The +++ stuff is then generated from a .nw (.pamphlet) file, so that the compiler can access it.


All I want to say is. The +++ documentation should not be considered as a primary documentation format. It is too unstructured.

Ralf