On Tue, Nov 4, 2008 at 5:55 PM, Ronan Paixão <[EMAIL PROTECTED]> wrote: > > > > Em Qua, 2008-11-05 às 12:07 +1100, Minh Nguyen escreveu: >> On Wed, Aug 27, 2008 at 10:17 AM, Minh Nguyen <[EMAIL PROTECTED]> wrote: >> > Hi Harald, >> > >> > On Tue, Aug 26, 2008 at 6:07 PM, Harald Schilly >> > <[EMAIL PROTECTED]> wrote: >> >> >> >> Hi, I want to propose a process to increase the quality of the Sage >> >> documentation. This is the by far most annoying thing about Sage >> >> according to the last survey. I think the userbase is already big and >> >> willing enough to contribute more documentation. To do this in a more >> >> coordinated way, there should be some sort of process and guidelines. >> > [...] >> >> Therefore, I hope, some folks are interested to start and once there >> >> is already something online, more and more should come. >> >> >> >> ideas, thoughts, comments? H >> > > It would be nice to have some "code repository" like the cookbook in > ActiveState's website. > > I have always envied php.net's help site. Python's documentation (in my > opinion) just isn't par with it, specially in the "examples" category. > At least sage does a good work with most docstrings, with helpful > examples, but sometimes it would be nice to have an easily searchable > database, because a lot of times I know what I want to do but I don't > know what function does it (and sometimes I don't even know there's a > function for it).
Having some meta information in docstrings, and extracting such a document from docstrings would be pretty cool. Whatever we do, it's critically important that it be automatically test-able. William --~--~---------~--~----~------------~-------~--~----~ To post to this group, send email to sage-devel@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sage-devel URLs: http://www.sagemath.org -~----------~----~----~----~------~----~------~--~---
