axiom-developer
[Top][All Lists]

## Re: [Axiom-developer] documentation standards?

 From: daly Subject: Re: [Axiom-developer] documentation standards? Date: Wed, 22 Oct 2014 20:46:40 -0500

Kurt Pagani has posted an example of documentation that really
raises the bar for what would constitute "well documented" Spad code.
Not everyone will go this far but this shows what could be done.

Imagine what a pleasure it would be to work in a system that had
this level of documentation for all of the code.

I've put a copy at
http://daly.axiom-developer.org/DiffForm.pdf

Axiom is literate so the code segments will end up being wrapped
with \begin{chunk}...\end{chunk} which makes it possible to extract
the actual code and compile it with the rest of the system.

Beautiful work, Kurt.

Tim