William Stein wrote: > On Mon, Oct 12, 2009 at 6:24 PM, John H Palmieri <jhpalmier...@gmail.com> > wrote: >> On Oct 12, 5:08 pm, William Stein <wst...@gmail.com> wrote: >>> On Mon, Oct 12, 2009 at 4:45 PM, Kwankyu <ekwan...@gmail.com> wrote: >>> >>>> Hi Minh, >>>> I still have a problem on this issue. >>>> 1. "TESTS:" section is not documented in the developer manual as of >>>> Sage 4.1.1 >>>> 2. Examples in "TESTS:" section are still included in the Sage >>>> reference manual. If they are intended for test purpose only, then >>>> they should not be included in the reference manual, which is for the >>>> users. >>>> Do I misunderstand something? >>> No, we just have not got around to actually implementing 2 yet. Want to >>> help? >> I would point out that in the code, some examples in the TESTS section >> can be quite helpful to users. So if someone wants to implement 2, >> they had better check whether each such example is worth including in >> the reference manual (and so should be moved to the EXAMPLES block) or >> not. Including too many examples is better than including too few. > > Maybe we should not bother implementing 2? Nobody has pushed to do > it, and your remark above just made it a difficult task. It will also > be potentially be difficult to maintain, since it means potentially > tricky and bug-prone patches to how we use Sphinx *and* IPython *and* > the Notebook.
Perhaps collapsible headings (so "TESTS" was automatically collapsed) would answer the need to not inundate the user with a million tests for each case of a function, while also letting the user access every bit of documentation if they so desire. Jason -- Jason Grout --~--~---------~--~----~------------~-------~--~----~ To post to this group, send an email to sage-devel@googlegroups.com To unsubscribe from this group, send an email to sage-devel-unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sage-devel URL: http://www.sagemath.org -~----------~----~----~----~------~----~------~--~---
