Dieter Kaiser wrote:
> Because we do not have a technical documentation of Maxima internals, I
> have started to write some documentations of functions I have worked on.
> The following examples try to document the functions PLS, ADDK, EXPTA,
> and EXPTB in simp.lisp. I have taken the Common Lisp HyperSpec as a
> guide to document the functions.
>
> I am interested to add the documentations to the project. We might add
> it to the Lisp files (the documentation might be to verbose) or we start
> to add a technical documentation in a TEXI format.
>
> Opinions or suggestions?
>
I agree that information like this should be in the source code.
I would also like to see some external texinfo "how to" docs. For example:
- how to add new special functions, including all the properties that
can be defined
- how to use core functionality, without duplicating comments in the source
- how to extend the ....
- preferred coding styles, when things are done in multiple ways in
existing code