Nicolas M. Thiery wrote: > On Tue, Jun 02, 2009 at 10:32:34AM -0700, William Stein wrote:
<SNIP> >> There's interest in creating a function in Sage that will apply the >> patches from a given trac ticket, run all tests, verify that the docs >> don't break, and report the result. The idea is that this will be >> done 100% automatically on the high-powered sage.math box. The script >> would also verify that every function touched by the patch has a >> doctest. Then essentially all of the guidelines: >> >> # 100% Doctests: All new code must be 100% doctested. There is no way >> around this. >> # Test the reference manual: sage -docbuild reference html must >> produce no errors >> # Test the Sage library: make test or make ptest (edit number of >> threads in makefile before using ptest!) A related ticket is #6226. It already has positive review and I anticipate that it'll be merged in 4.0.2. I thought that mabshoff's guidelines on reviewing tickets should be in the developer's guide and so #6226 does that. Not only that, but docstring should follow proper ReST formatting. Many times I see tickets with positive reviews, but the docstring doesn't contain proper ReST formatting so when the reference manual is built, some documentation for functions doesn't show up properly. Ticket #6226 also adds info on ReST formatting, taken from the wiki page written by Florent Hivert. >> would be verified completely automatically. Your task as a reviewer >> would only come after the script signs off that the above conditions >> are met. > > +1 !!! > > Dream feature: having a button on the trac ticket web page that would > run this script on sage.math (don't know if this is easily doable though). > > Cheers, > Nicolas > -- > Nicolas M. Thiéry "Isil" <nthi...@users.sf.net> > http://Nicolas.Thiery.name/ -- Regards Minh Van Nguyen --~--~---------~--~----~------------~-------~--~----~ To post to this group, send email to sage-devel@googlegroups.com To unsubscribe from this group, send email to sage-devel-unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sage-devel URLs: http://www.sagemath.org -~----------~----~----~----~------~----~------~--~---
