> 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... >
Agree. I did not have in mind well-known algorithms. See for example the compete documentation issue overview of Singulars 'factory', https://github.com/Singular/Sources/issues/637 More than 60 percent of the source code is not documented at all. 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. > You score a point here (use Python's inspection abilities) Despite from that I hope you understand what I have in mind with developer documentation. I really hope that I'm wrong, but I predict that in case that it is missing or not adequate, in ten or twenty years sage may get serious problems with rotten and unmaintainable source code, because at that point many current developers will have left the sage project and fresh developers may fail to understand the old sources. And because in history predictors or carriers of bad news were burned, I will shut up now on that topic. Jakob Am Montag, 5. Januar 2015 22:41:32 UTC+1 schrieb Volker Braun: > > 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. >> > > -- 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 [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/sage-devel. For more options, visit https://groups.google.com/d/optout.
