On Monday, January 5, 2015 5:45:21 PM UTC+1, Jakob Kroeker wrote:

> class diagrams,  state transition diagrams, internal code 
> interdependencies/implemented design patterns, call graphs


How is the class hierarchy not best described by the code? If you can't be 
bothered to read the code you can also use Python's inspection abilities.

Adding a link/reference to the underlying algorithm is definitely desirable.
>
> Despite from the fact that (I guess) this basic rule is obvious, in 
> reality its often violated, at least in Singular code.
>

Again it depends on the case. Not every algorithm needs to be documented, 
some things are necessarily assumed to be known to anybody who wants to 
make relevant changes. I don't think Sage explains the algorithm for 
solving CRT anywhere...

-- 
You received this message because you are subscribed to the Google Groups 
"sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sage-devel+unsubscr...@googlegroups.com.
To post to this group, send email to sage-devel@googlegroups.com.
Visit this group at http://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

Reply via email to