I agree with Nathan that it would be good to have "internal" documentation more accessible (and to write more of it). I don't see any issues with "scaring" ordinary users as this material should be in the developers manual rather than the reference manual.
At the moment we are writing a lot of documentation that sphinx simply ignores. As Travis says, we can read this documentation in the source files but as we are all spending a lot of time writing this documentation why not take more advantage of it? Is there any reason not to have an "expanded" developers guide that includes all of the ReST documentation available in the source? Alternatively, it shouldn't be hard to have sphinx add the documentation for the __init__ method of a class as a special "Technical specification" section of the class documentation. Andrew On Monday, 5 January 2015 07:03:04 UTC+11, Jori Mantysalo wrote: > > On Sat, 27 Dec 2014, Travis Scrimshaw wrote: > > > If you're developing, you're...not...looking at the code? That's how I'm > > interpreting your comments. > > Is there "internal" documentation in Sage? If so, where it is? > > I mean that if a developer wants to know how some class is made (and maybe > WHY, if there are nontrivial choises for data structure), should he or she > always found it with "<class>.__init__?"? Or by looking at start of source > code file, or from the end of file? > > -- > Jori Mäntysalo > -- 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.
