> > My (obvious) suggestion is to add at the end of a function doc (close to > > reference) a section e.g.: > > > > ALGORITHM: > > > > - modified merge sort algorithm. The complexity ``O(n * ln(n))`` is > > optimal however it has a bad constant time factor. We therefore use a > > naive method for ``n <= 27``. > > > > > > REFERENCES: > > > > - ... > > > > AUTHORS: > > > > - ... > > > > Do you think about something even more structured ? > > That's a good example. I wonder if LaTeX typesetting would be nicer, > e.g. `O(n\ln(n))` and `n\leq 27`?
Unfortunately, we currently have very few notes like this (I found only 6 of them). So I copy pasted the example from MuPAD rather than from sage, which is a Pity. If we agree on the "ALGORITHM:" section, I'll post a patch to advertise this design in the developer guide, and apply this in some place in combinat. Just to be sure: there is no special treatment by sphinx for this kind of section ? Sphinx isn't aware at all of the meaning of REFERENCES or AUTHORS, is it ? Cheers, Florent -- To post to this group, send an email to [email protected] To unsubscribe from this group, send an email to [email protected] For more options, visit this group at http://groups.google.com/group/sage-devel URL: http://www.sagemath.org
